Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Update devnotes #2745

Merged
merged 3 commits into from
Dec 5, 2024
Merged

[doc] Update devnotes #2745

merged 3 commits into from
Dec 5, 2024

Conversation

snf2ye
Copy link
Contributor

@snf2ye snf2ye commented Dec 4, 2024

Hopefully clarifies a few of these steps for new users getting started on duos ui. The changes reflect areas that I was confused by.

  • Give more specifics to the use of./render-configs and make more prominent in the instructions.
  • Remove instructions that are covered by ./render-configs. We can use the script as documentation for the steps so that we do not need to maintain this in two places.
  • Update ./render-configs to differentiate between the parameters that set values (project) vs. boolean values (env -> write_env)
  • Bug: I found that I had to be in the scripts directory before calling ./render-configs.sh, so I've made that clear in the instructions. But, we may want to figure out how to run ./scripts/render-configs.sh directly.

@snf2ye snf2ye requested a review from a team as a code owner December 4, 2024 21:20
@snf2ye snf2ye requested review from s-rubenstein and cinyecai and removed request for a team December 4, 2024 21:20
Copy link
Contributor

@rushtong rushtong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏽

Copy link
Contributor

@fboulnois fboulnois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you consider adding the newlines between coding blocks? Otherwise looks good and I'll close my PR.

I found it confusing that "env" was a boolean value instead of a variable that set the environment for the configs. But, glad to switch this back if others disagree.
@snf2ye snf2ye force-pushed the sh/update-getting-started-docs branch from 0118b89 to 66fd044 Compare December 5, 2024 17:58
"These additional spaces are added because not all markdown parsers recognize the triple backticks directly after a string." -fb
@snf2ye
Copy link
Contributor Author

snf2ye commented Dec 5, 2024

Would you consider adding the newlines between coding blocks? Otherwise looks good and I'll close my PR.

For sure, done! Hopefully I didn't miss any.

@snf2ye snf2ye merged commit 0b8f37a into develop Dec 5, 2024
9 checks passed
@snf2ye snf2ye deleted the sh/update-getting-started-docs branch December 5, 2024 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants