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

Documentation bootstrap #821

Merged
merged 42 commits into from
Oct 26, 2023
Merged

Documentation bootstrap #821

merged 42 commits into from
Oct 26, 2023

Conversation

didrocks
Copy link
Member

No description provided.

@jibel jibel force-pushed the documentation_bootstrap branch 4 times, most recently from 5446d8c to 50cd8dc Compare October 24, 2023 11:50
jibel and others added 16 commits October 26, 2023 11:17
The documentation has been moved to doc/ and updated to be published to
read the doc with in particular table of content.

The documentation is now parsed to follow the ToC, point the images to
the right addresses and remove internal links.
The reference documentation is now split in 3 parts for each major
component of ADSys. This replaces the old reference documentation.

The doc has been reorganised to match the new layout of Read The Doc.
And dropped the old one.
Co-authored-by: Didier Roche <didrocks@ubuntu.com>
Co-authored-by: Didier Roche <didrocks@ubuntu.com>
Removed obsolete documentation and updated GitHub workflow accordingly.

Co-authored-by: Didier Roche <didrocks@ubuntu.com>
Co-authored-by: Didier Roche <didrocks@ubuntu.com>
Co-authored-by: Didier Roche <didrocks@ubuntu.com>
Cobra doesn't consider command line option when running completion. It
has to be done explicitly.

Co-authored-by: Didier Roche <didrocks@ubuntu.com>
Co-authored-by: Didier Roche <didrocks@ubuntu.com>
Co-authored-by: Didier Roche <didrocks@ubuntu.com>
Co-authored-by: Didier Roche <didrocks@ubuntu.com>
@codecov-commenter
Copy link

codecov-commenter commented Oct 26, 2023

Codecov Report

Merging #821 (4f94e2d) into main (35fd623) will increase coverage by 0.02%.
Report is 13 commits behind head on main.
The diff coverage is 79.58%.

@@            Coverage Diff             @@
##             main     #821      +/-   ##
==========================================
+ Coverage   86.07%   86.10%   +0.02%     
==========================================
  Files          77       76       -1     
  Lines        8552     8599      +47     
==========================================
+ Hits         7361     7404      +43     
+ Misses        868      866       -2     
- Partials      323      329       +6     
Files Coverage Δ
cmd/adsysd/client/policy.go 72.06% <100.00%> (ø)
cmd/adsysd/daemon/daemon.go 85.71% <100.00%> (ø)
cmd/adsysd/client/client.go 77.94% <57.14%> (-2.71%) ⬇️
cmd/adsysd/client/doc.go 67.24% <62.50%> (-0.72%) ⬇️
internal/adsysservice/doc.go 74.62% <81.81%> (+4.62%) ⬆️

... and 2 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Co-authored-by: Didier Roche <didrocks@ubuntu.com>
@didrocks didrocks marked this pull request as ready for review October 26, 2023 14:31
@didrocks didrocks requested a review from a team as a code owner October 26, 2023 14:31
Copy link
Collaborator

@jibel jibel 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 good, reviewed together live.

@jibel jibel merged commit aafc642 into main Oct 26, 2023
6 checks passed
@jibel jibel deleted the documentation_bootstrap branch October 26, 2023 14:33
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