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 infrastructure docs and diagrams #307

Merged
merged 7 commits into from
Jul 24, 2024

Conversation

viniciusdc
Copy link
Contributor

Reference Issues or PRs

closes #255

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?

Copy link

vercel bot commented May 28, 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 Jul 24, 2024 1:53pm
jhub-apps-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 24, 2024 1:53pm

@viniciusdc
Copy link
Contributor Author

This is a first pass on the writing, I still need to update the bottom part as I think its confusing

Copy link
Contributor

@kcpevey kcpevey left a comment

Choose a reason for hiding this comment

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

@viniciusdc This covers a lot of really great information! I left a few suggestions on content and also did a grammatical review. Thanks for opening this!

docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
@kcpevey
Copy link
Contributor

kcpevey commented Jun 18, 2024

@viniciusdc is this ready for review again?

@viniciusdc
Copy link
Contributor Author

I am just refactoring that last part, will ping you shortly

@viniciusdc
Copy link
Contributor Author

sorry for the delay here @kcpevey, I finished my updates on this, its now ready for a final review. I am happy with how the last sections ended up now :)

docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@kcpevey kcpevey left a comment

Choose a reason for hiding this comment

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

I just had some minor grammatical updates. Feel free to fix if you agree and merge :)

docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
### How does all Work Together?

As an example, the diagram below illustrates the interaction between the two given
proxies (http--jupyter-server-proxy or http--jhub-single-native), in a kubernetes
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
proxies (http--jupyter-server-proxy or http--jhub-single-native), in a kubernetes
proxies (`http--jupyter-server-proxy` or `http--jhub-single-native`), in a Kubernetes

Copy link
Contributor

Choose a reason for hiding this comment

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

Just to double check - those are supposed to be double dashes, right? e.g. http--

docs/docs/concepts/infrastructure-architecture.mdx Outdated Show resolved Hide resolved
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
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.

[DOC] - Create architecture diagram
3 participants