POD-894: Add PUML diagrams to docs #1311
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pascalbreuninger
approved these changes
Oct 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Supersedes #1275
This PR updates the OSS docs to include two new sections, "tutorials" and "concepts" to provide the left two sections of https://diataxis.fr/
The aim is to provide more information on how devpod works, so users understand it's value and helping when determining compliance. The tutorials section's aim is to provide guides on how users can perform common tasks / workflows and to advertise new features (such as remote cache).
There are some PUML diagrams in
docs/umlused to generate the diagrams in the docs. @Piotr1215 I would appreciate your feedback here if there is anything I can improve with the UML / annotations. I used C4 notation as I really liked it and found a low barrier to entry if your already familiar with PUML.@pascalbreuninger @janekbaraniewski please can you review the diagrams themselves fully and ensure I have not misunderstood or got something technically wrong.