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: moving docs to pages #3633

Merged
merged 13 commits into from
Dec 20, 2023
Merged

docs: moving docs to pages #3633

merged 13 commits into from
Dec 20, 2023

Conversation

npalm
Copy link
Member

@npalm npalm commented Nov 22, 2023

The documentation in our README have become quite extensive over the years. This PR is moving docs including examples and modules to a documentation site. The top-level readme is shrinked down to some basic / essential information.

For examples and module documentation sources in example and module directories are linked.

@npalm npalm marked this pull request as draft November 22, 2023 18:31
@npalm npalm force-pushed the npalm/mkdocs branch 3 times, most recently from 336c95e to c8a0604 Compare December 17, 2023 10:51
@npalm npalm marked this pull request as ready for review December 17, 2023 12:58
@npalm npalm mentioned this pull request Dec 17, 2023
@sdarwin
Copy link
Contributor

sdarwin commented Dec 17, 2023

the reorganization is looking very nice. when possible it's probably better not to hard-code full URLs such as "https://philips-labs.github.io/terraform-aws-github-runner/modules/public/ami-housekeeper/" if documentation is referring to itself it could use a relative path.

@sdarwin
Copy link
Contributor

sdarwin commented Dec 17, 2023

Minor spelling issue: Introduciton -> Introduction

For each page of text if you quickly copy-paste it into Gmail, that has a built-in spell checker and will suggest what should be fixed.

At least with paragraphs of written content. Maybe it skips formatted YAML documents, and so won't catch everything.

@npalm
Copy link
Member Author

npalm commented Dec 19, 2023

the reorganization is looking very nice. when possible it's probably better not to hard-code full URLs such as "https://philips-labs.github.io/terraform-aws-github-runner/modules/public/ami-housekeeper/" if documentation is referring to itself it could use a relative path.

would be much better, but it is hard to link from both the docs side and the readme's correctly.

koendelaat
koendelaat previously approved these changes Dec 20, 2023
koendelaat
koendelaat previously approved these changes Dec 20, 2023
Copy link
Contributor

@Brend-Smits Brend-Smits left a comment

Choose a reason for hiding this comment

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

Minor changes, this is a welcoming change.

@npalm
Copy link
Member Author

npalm commented Dec 20, 2023

Pages branch set to gh-pages

@npalm npalm merged commit c98f7f7 into main Dec 20, 2023
@npalm npalm deleted the npalm/mkdocs branch December 20, 2023 10:40
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.

4 participants