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

docs: Expose "API documentation" and restructure users docs #1316

Merged
merged 1 commit into from
Feb 7, 2024

Conversation

MoritzWeber0
Copy link
Member

@MoritzWeber0 MoritzWeber0 commented Feb 5, 2024

  • 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.

Resolves #1066

TODO:

  • Write full T4C setup guide
  • Connect to T4C missing
  • Page redirects
  • Change absolute to relative links

Copy link

codecov bot commented Feb 5, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (54ba4a6) 73.21% compared to head (b3cae4d) 73.21%.
Report is 2 commits behind head on main.

Files Patch % Lines
backend/capellacollab/__main__.py 75.00% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

@MoritzWeber0 MoritzWeber0 force-pushed the expose-api-docs branch 2 times, most recently from 33185d4 to 4f0a1f7 Compare February 5, 2024 16:13
@MoritzWeber0 MoritzWeber0 marked this pull request as ready for review February 5, 2024 16:23
@MoritzWeber0 MoritzWeber0 requested review from romeonicholas and removed request for amolenaar February 6, 2024 13:15
@MoritzWeber0
Copy link
Member Author

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.

docs/docs/index.md Outdated Show resolved Hide resolved
@romeonicholas
Copy link
Contributor

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.
Copy link

sonarqubecloud bot commented Feb 7, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@MoritzWeber0 MoritzWeber0 merged commit 1b146ad into main Feb 7, 2024
26 checks passed
@MoritzWeber0 MoritzWeber0 deleted the expose-api-docs branch February 7, 2024 07:55
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.

Expose backend API documentation
2 participants