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: Add installation guide to mkdocs #1053

Merged
merged 6 commits into from
Oct 9, 2023
Merged

Conversation

MoritzWeber0
Copy link
Member

There is also a less detailed installation guide in the README. These instructions should be merged in a later PR.

@Paula-Kli
Copy link
Contributor

Would it until it is merged with the readme be beneficial to add a hint in the readme to read the user docs for installation setup purposes? Maybe one sentence is enough but will make it a lot more discoverable

@codecov
Copy link

codecov bot commented Sep 26, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (0ac29f5) 71.06% compared to head (2dda1d4) 71.06%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1053   +/-   ##
=======================================
  Coverage   71.06%   71.06%           
=======================================
  Files         155      155           
  Lines        4869     4869           
  Branches      522      522           
=======================================
  Hits         3460     3460           
  Misses       1312     1312           
  Partials       97       97           

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

@MoritzWeber0 MoritzWeber0 force-pushed the installation-documentation branch from 493b08f to 8e66cc5 Compare September 26, 2023 15:34
@MoritzWeber0
Copy link
Member Author

Would it until it is merged with the readme be beneficial to add a hint in the readme to read the user docs for installation setup purposes? Maybe one sentence is enough but will make it a lot more discoverable

Done. I just removed the whole "production" installation instructions from the README. Also added TeamForCapella client installation instructions.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Paula-Kli Paula-Kli 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 read it and did not try it out so can not say whether I as a user would miss a step but I think it is really useful and very detailed 👍 Good docs

docs/user/docs/installation.md Outdated Show resolved Hide resolved
docs/user/docs/installation.md Outdated Show resolved Hide resolved
docs/user/docs/installation.md Outdated Show resolved Hide resolved
docs/user/docs/installation.md Show resolved Hide resolved
docs/user/docs/installation.md Show resolved Hide resolved
docs/user/docs/installation.md Outdated Show resolved Hide resolved
docs/user/docs/installation.md Show resolved Hide resolved
docs/user/docs/installation.md Outdated Show resolved Hide resolved
@MoritzWeber0 MoritzWeber0 force-pushed the installation-documentation branch from 249e781 to a270163 Compare October 9, 2023 13:55
There is also a less detailed installation guide in the README.
These instructions should be merged in a later PR.
The resource section was added to the user documentation.
The installation part of the README was moved to the user docs.
@MoritzWeber0 MoritzWeber0 force-pushed the installation-documentation branch from a270163 to 2dda1d4 Compare October 9, 2023 13:55
@MoritzWeber0 MoritzWeber0 enabled auto-merge October 9, 2023 13:57
@MoritzWeber0 MoritzWeber0 merged commit 668caba into main Oct 9, 2023
23 checks passed
@MoritzWeber0 MoritzWeber0 deleted the installation-documentation branch October 9, 2023 14:16
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.

3 participants