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: Fix documentation according to user feedback #1206

Merged
merged 2 commits into from
Jan 29, 2024

Conversation

Paula-Kli
Copy link
Contributor

@Paula-Kli Paula-Kli commented Nov 27, 2023

In the jupyter section was a video that I was not able to open locally neither did it play in the docs - is that just me or a general problem?

Also please read the update of the capella model carefully - not sure whether everything is correct in there

Copy link

codecov bot commented Nov 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (94cbd98) 72.83% compared to head (ebc17d8) 72.83%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1206   +/-   ##
=======================================
  Coverage   72.83%   72.83%           
=======================================
  Files         162      162           
  Lines        5345     5345           
  Branches      601      601           
=======================================
  Hits         3893     3893           
  Misses       1321     1321           
  Partials      131      131           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Paula-Kli Paula-Kli marked this pull request as ready for review November 27, 2023 10:38
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@MoritzWeber0 MoritzWeber0 requested review from dominik003 and amolenaar and removed request for dominik003 December 11, 2023 10:43
@MoritzWeber0
Copy link
Member

MoritzWeber0 commented Dec 11, 2023

@amolenaar Can you review the changes from the "user" perspective? Are the workflows still correct?

docs/docs/user/projects/models/create.md Outdated Show resolved Hide resolved
docs/docs/user/projects/models/update.md Outdated Show resolved Hide resolved
docs/docs/user/projects/models/update.md Outdated Show resolved Hide resolved
@Paula-Kli Paula-Kli force-pushed the fix-documentation branch 2 times, most recently from e10eb1a to 69b1ff4 Compare January 8, 2024 08:17
Copy link
Contributor

@dominik003 dominik003 left a comment

Choose a reason for hiding this comment

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

Thanks for updating the docs. I have just a few comments and after they are resolved we can merge this one.

docs/docs/user/projects/models/create.md Outdated Show resolved Hide resolved
docs/docs/user/projects/models/update.md Outdated Show resolved Hide resolved
docs/docs/user/projects/models/metadata.md Outdated Show resolved Hide resolved
docs/docs/user/tools/capella/update.md Show resolved Hide resolved
Copy link
Contributor

@amolenaar amolenaar left a comment

Choose a reason for hiding this comment

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

It looks more clear this way.

One small improvement suggestion.

docs/docs/user/projects/models/create.md Outdated Show resolved Hide resolved
Copy link

The pull request does not conform to the conventional commit specification. Please ensure that your commit messages follow the spec: https://www.conventionalcommits.org/.
We also strongly recommend that you set up your development environment with pre-commit, as described in our Developer documentation. This will run all the important checks right before you commit your changes, and avoids lengthy CI wait time and round trips.

This is the commit validation log:

⧗   input: docs: Update documentation about T4C token and merge flow and import t4c model documentation
✖   subject must not be longer than 72 characters [subject-max-length]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Here are some examples of valid commit messages:

build: Bump frontend versions
docs(user): Add model creation workflow
feat: Add a monitoring dashboard

@Paula-Kli Paula-Kli force-pushed the fix-documentation branch 2 times, most recently from 83c7d96 to 8358647 Compare January 29, 2024 08:08
Copy link
Member

@MoritzWeber0 MoritzWeber0 left a comment

Choose a reason for hiding this comment

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

Thanks for the improvement, looks good in general :)

There is a new Github action to check for mkdocs warnings, please rebase on main to get it in this PR.

In addition, I have two small comments. Once they are resolved, the PR can be merged.

docs/mkdocs.yml Outdated Show resolved Hide resolved
docs/docs/user/tools/capella/update.md Outdated Show resolved Hide resolved
@MoritzWeber0 MoritzWeber0 dismissed dominik003’s stale review January 29, 2024 10:13

Conversations are resolved & @dominik003 is out of office.

Remove video for jupyter notebook introduction. Move settings documentation from user to administrator documentation. Some smaller adjustments.
Copy link

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 bfc9d47 into main Jan 29, 2024
26 checks passed
@MoritzWeber0 MoritzWeber0 deleted the fix-documentation branch January 29, 2024 11:23
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.

4 participants