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

Update docs to the latest UI #478

Merged
merged 3 commits into from
Sep 20, 2024
Merged

Update docs to the latest UI #478

merged 3 commits into from
Sep 20, 2024

Conversation

kcpevey
Copy link
Contributor

@kcpevey kcpevey commented Sep 13, 2024

The UI has had a lot of improvements recently. Now that the interface has stabilized a bit, its time to update docs. This PR updates all the relevant images and also modifies wording in a few places.

Reference Issues or PRs

Resolves #411

What does this implement/fix?

Put a 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 not to 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?

@kcpevey kcpevey added the area: documentation 📖 Improvements or additions to documentation label Sep 13, 2024
Copy link

vercel bot commented Sep 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
jhub-apps ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 19, 2024 6:36pm
jhub-apps-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 19, 2024 6:36pm

@kcpevey
Copy link
Contributor Author

kcpevey commented Sep 13, 2024

This is ready for review whenever someone has time :)

@kcpevey kcpevey added the needs: review 👀 This PR is complete and ready for reviewing label Sep 13, 2024
Copy link
Member

@aktech aktech left a comment

Choose a reason for hiding this comment

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

Looks good, apart from some minor suggestions.

docs/docs/create-apps/custom-app.md Outdated Show resolved Hide resolved
docs/docs/create-apps/general-app.md Outdated Show resolved Hide resolved
docs/docs/create-apps/general-app.md Outdated Show resolved Hide resolved
docs/docs/create-apps/general-app.md Outdated Show resolved Hide resolved
docs/docs/create-apps/general-app.md Outdated Show resolved Hide resolved
docs/docs/create-apps/general-app.md Outdated Show resolved Hide resolved
docs/docs/create-apps/general-app.md Outdated Show resolved Hide resolved
docs/docs/create-apps/general-app.md Outdated Show resolved Hide resolved
Co-authored-by: Amit Kumar <dtu.amit@gmail.com>
@kcpevey
Copy link
Contributor Author

kcpevey commented Sep 19, 2024

@aktech I've made all the suggested modifications. This is ready for another look.

Copy link
Member

@aktech aktech left a comment

Choose a reason for hiding this comment

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

Looks awesome, thanks @kcpevey 🎉

@aktech aktech merged commit 84b5e8e into main Sep 20, 2024
25 checks passed
@aktech aktech deleted the docs_update branch September 20, 2024 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 Improvements or additions to documentation needs: review 👀 This PR is complete and ready for reviewing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] - App creation UI out of date in documentation
2 participants