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

Netplan: Fix docs directory structure to reflect Diátaxis #125

Open
rkratky opened this issue Aug 19, 2024 · 1 comment
Open

Netplan: Fix docs directory structure to reflect Diátaxis #125

rkratky opened this issue Aug 19, 2024 · 1 comment
Assignees
Labels
size 2 Fix a known documentation issue (size 2/8)

Comments

@rkratky
Copy link
Collaborator

rkratky commented Aug 19, 2024

Context

The Netplan docs don't have a Diátaxis-based sub-directory structure, which makes it unnecessarily difficult to find one's way around the docs source code. Also, the Netplan docs contribution guide talks about this (non-existent) directory structure, which is incorrect and confusing.

Task

  • Create a Diátaxis based sub-directory structure under the doc/ directory in the Netplan repo
  • Move existing docs articles to their respective sub-directories (based on the article type)
  • Ensure all respective TOCs and links have been updated to reflect the new locations

Reference

@rkratky rkratky added the size 2 Fix a known documentation issue (size 2/8) label Aug 19, 2024
@davidekete
Copy link
Contributor

Hi @rkratky, I'd like to work on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size 2 Fix a known documentation issue (size 2/8)
Projects
None yet
Development

No branches or pull requests

2 participants