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

Collect links to all howtos in one place #2716

Merged
merged 2 commits into from
Nov 10, 2023

Conversation

hmpf
Copy link
Contributor

@hmpf hmpf commented Nov 8, 2023

Closes #2715

@hmpf hmpf added the documentation Related to documentation of NAV label Nov 8, 2023
@hmpf hmpf self-assigned this Nov 8, 2023
@hmpf hmpf force-pushed the doc-restructure-howtos branch from 2c099bc to fc6292b Compare November 8, 2023 08:47
@hmpf hmpf requested a review from lunkwill42 November 8, 2023 08:54
Copy link

github-actions bot commented Nov 8, 2023

Test results

     12 files       12 suites   12m 44s ⏱️
3 221 tests 3 221 ✔️ 0 💤 0
9 138 runs  9 138 ✔️ 0 💤 0

Results for commit 8b8b490.

♻️ This comment has been updated with latest results.

Copy link

codecov bot commented Nov 8, 2023

Codecov Report

Merging #2716 (8b8b490) into master (e297772) will not change coverage.
Report is 1 commits behind head on master.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2716   +/-   ##
=======================================
  Coverage   55.19%   55.19%           
=======================================
  Files         561      561           
  Lines       40917    40917           
=======================================
  Hits        22584    22584           
  Misses      18333    18333           

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

Copy link
Member

@lunkwill42 lunkwill42 left a comment

Choose a reason for hiding this comment

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

Great idea and cleanup. Just a nitpick, see inline.

doc/howto/index.rst Outdated Show resolved Hide resolved
Keep howtos that are vaguely about the same things together. Also, turns
out api_paramters is reference material, but we're not moving it now.

Small steps towards a more diátaxis future :)
Copy link

sonarqubecloud bot commented Nov 8, 2023

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

@hmpf
Copy link
Contributor Author

hmpf commented Nov 8, 2023

Should getting-organized also be with the howtos? Not that this is the PR to do it.

@lunkwill42
Copy link
Member

Should getting-organized also be with the howtos? Not that this is the PR to do it.

Maybe. Should probably have a full team review of the docs, methinks...

@hmpf hmpf merged commit d9e4442 into Uninett:master Nov 10, 2023
@hmpf hmpf deleted the doc-restructure-howtos branch November 10, 2023 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation of NAV
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganize the howtos in the documentation
2 participants