-
Notifications
You must be signed in to change notification settings - Fork 4
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
docs: Expose "API documentation" and restructure users docs #1316
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #1316 +/- ##
=======================================
Coverage 73.21% 73.21%
=======================================
Files 166 166
Lines 5428 5432 +4
Branches 607 608 +1
=======================================
+ Hits 3974 3977 +3
- Misses 1323 1324 +1
Partials 131 131 ☔ View full report in Codecov by Sentry. |
33185d4
to
4f0a1f7
Compare
4f0a1f7
to
abf64f1
Compare
Hi @romeonicholas, I know that the PR contains documentation about parts that you haven't touched yet. Nevertheless, you're the only one who is currently available from the Collaboration Manager team, so I'd appreciate your review. If you have any questions, feel free to reach out. |
abf64f1
to
f7ba9d1
Compare
I dig the screenshot folder additions, much cleaner 🥇 |
- A new section "API documentation" is added; PAT and authentication information is moved to the new section. - The new API documentation has a new Python example. - The new section has a link to the OpenAPI documentation, which in only accessible for running Collaboration Manager instances. - The OpenAPI documentation uses the correct auto-determined version now (before it was 0.1.0) - The Path to the documentation has changes, a prefix `/api/docs` was added, a redirect from the old `/docs` route is in place. - The "Tools" abstraction layer was removed in the tree. Instead, Capella & Jupyter have top level sections now. The goal is to increase visibility for the Capella section, which is frequently used. - "Flows" has been removed from the "Sessions" section; sessions will focus on tool independent topics; T4C flow is moved to "Capella" section - The Git workflow and API documentation are now mentioned in the Introduction of the user docs - For consistency, the Git workflow has it's own folder in the Capella section now (like T4C also has) - A full T4C setup guide was added, describing the creation of a T4C based project, from project creation to diagram cache setup. - Some general grammar & style improvements. - Old references to `Profile` are updated to `Menu` - Administrative T4C pages are moved to the admin section.
f7ba9d1
to
b3cae4d
Compare
Quality Gate passedKudos, no new issues were introduced! 0 New issues |
is moved to the new section.
accessible for running Collaboration Manager instances.
/api/docs
was added,a redirect from the old
/docs
route is in place.Instead, Capella & Jupyter have top level sections now.
The goal is to increase visibility for the Capella section, which is frequently used.
on tool independent topics; T4C flow is moved to "Capella" section
of the user docs
(like T4C also has)
from project creation to diagram cache setup.
Profile
are updated toMenu
Resolves #1066
TODO: