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

Add nebari typer cli changes #150

Merged
merged 24 commits into from
Oct 21, 2022
Merged

Add nebari typer cli changes #150

merged 24 commits into from
Oct 21, 2022

Conversation

asmijafar20
Copy link
Contributor

@asmijafar20 asmijafar20 commented Sep 28, 2022

Reference Issues or PRs

What does this implement/fix?

Put an x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features to not work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

@netlify
Copy link

netlify bot commented Sep 28, 2022

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 53bfd11
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/63516cb0a50c0d0009f68c87
😎 Deploy Preview https://deploy-preview-150--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Member

@trallard trallard left a comment

Choose a reason for hiding this comment

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

Thanks for opening this PR @asmijafar20 it looks in pretty good shape. I added some comments and suggestions here and there.

I assume the GCP, Azure and DO docs will be updated as well.

docs/docs/getting-started/installing-nebari.md Outdated Show resolved Hide resolved
docs/docs/getting-started/installing-nebari.md Outdated Show resolved Hide resolved
docs/docs/getting-started/installing-nebari.md Outdated Show resolved Hide resolved
docs/docs/how-tos/nebari-aws.md Outdated Show resolved Hide resolved
docs/docs/how-tos/nebari-aws.md Outdated Show resolved Hide resolved
docs/docs/how-tos/nebari-aws.md Outdated Show resolved Hide resolved
@trallard trallard added the needs: changes 🧱 Review completed - some changes are needed before merging label Sep 30, 2022
@asmijafar20 asmijafar20 added the status: in progress 🏗 This task is currently being worked on label Oct 3, 2022
@asmijafar20
Copy link
Contributor Author

I added the suggested changes but didn't change the screenshots specifically for each cloud provider. I will do that once we have the final structure of the CLI.

@pavithraes pavithraes added this to the 🪴 Nebari rename milestone Oct 4, 2022
@asmijafar20 asmijafar20 added needs: review 👀 and removed status: in progress 🏗 This task is currently being worked on needs: changes 🧱 Review completed - some changes are needed before merging labels Oct 7, 2022
@pavithraes pavithraes self-requested a review October 10, 2022 21:12
@pavithraes pavithraes added the impact: high 🟥 This issue affects most of the nebari users label Oct 17, 2022
Copy link
Member

@iameskild iameskild left a comment

Choose a reason for hiding this comment

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

Thanks again @asmijafar20 for all your work on the CLI and docs :)

@pavithraes I believe this is ready to merge! Thanks for the thorough review as always :)

@pavithraes
Copy link
Member

Thank you for the updates! I've added back some nebari mentions that probably got overridden when merging main. We should be good to merge after this! ✨

@iameskild
Copy link
Member

@pavithraes sorry for the untidy merge conflict clean up 😅

I think this is ready to be merged now 🙌

@pavithraes
Copy link
Member

Thank you! I agree that we can merge. :)

I see a couple of things to update at a later date, and I've noted them in #188:

Link to the advanced configurations page about nebari-config.yaml in the cloud provider specific how-tos (2nd point under Nebari initialize). It currently links to qhub.dev. And, update in the output: QHUB_DEFAULT_PASSWORD to Nebari if/when that change is made.

@pavithraes pavithraes merged commit 6863716 into main Oct 21, 2022
@pavithraes pavithraes deleted the nebari_cli_docs branch October 21, 2022 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 impact: high 🟥 This issue affects most of the nebari users type: enhancement 💅🏼 New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

4 participants