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 files for RTD setup #1685

Merged
merged 2 commits into from Jun 12, 2023
Merged

Conversation

s-makin
Copy link
Contributor

@s-makin s-makin commented May 26, 2023

  • Add docs directory to keep files together
  • Add files necessary for RTD
  • Add style sheets for "Ubuntu" style
  • Add Diataxis outline and framework

Note, no docs files included yet, but this will
at least allow RTD to be set up for the project

- Add docs directory to keep files together
- Add files necessary for RTD
- Add style sheets for "Ubuntu" style
- Add Diataxis outline and framework
Copy link
Collaborator

@dbungert dbungert 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 getting this process started. I'd like to move the directory name to 'doc' to match the neighboring projects (cloud-init, curtin, netplan).

We do have an existing documentation directory in 'documentation', I would like a short README.md added in the 'doc' directory explaining the current state - basically, continue to add documentation changes to 'documentation' and this is the WIP location for future docs.

@s-makin
Copy link
Contributor Author

s-makin commented Jun 7, 2023

Thanks for getting this process started. I'd like to move the directory name to 'doc' to match the neighboring projects (cloud-init, curtin, netplan).

We do have an existing documentation directory in 'documentation', I would like a short README.md added in the 'doc' directory explaining the current state - basically, continue to add documentation changes to 'documentation' and this is the WIP location for future docs.

Thanks Dan, I've made the changes you requested.

After I've done the initial setup on RTD, I'll start moving content but I'll need to confirm with you exactly which pages, and which versions of those pages, should be used. There are some pages in the Server Guide (namely in the "tutorial" section) which I think should be part of the Subiquity docs but are not in the documentation/ folder and I'd like to get your opinions on those.

Copy link
Collaborator

@dbungert dbungert 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 this. I'm going to tweaking the wording on the README.md after we land this - I'd like doc to be the go forward location to match the other, similar, projects. (my fault for not explaining that correctly)

@dbungert dbungert merged commit 9bbf1ac into canonical:main Jun 12, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants