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

feat: new doc stack #34

Closed
wants to merge 5 commits into from
Closed

feat: new doc stack #34

wants to merge 5 commits into from

Conversation

agardnerIT
Copy link
Contributor

@agardnerIT agardnerIT commented Sep 11, 2024

This PR:

  1. Check out this PR (or open this PR in a codespace)
  2. Run pip install -r requirements.txt then mkdocs serve -a localhost:8000

Point your browser at http://localhost:8000

@agardnerIT agardnerIT mentioned this pull request Sep 11, 2024
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
Signed-off-by: Adam Gardner <[email protected]>
@agardnerIT agardnerIT changed the title New Doc Stack feat: new doc stack Sep 12, 2024
@agardnerIT agardnerIT marked this pull request as ready for review September 12, 2024 07:37
@agardnerIT
Copy link
Contributor Author

I'm ignoring the failing YAML lint as this is failing on files that I haven't touched naturally during this work and so don't want to change those files

@Nexucis
Copy link
Member

Nexucis commented Sep 12, 2024

Hi @agardnerIT ! Thank you for starting this rework. 🙏

I just went quickly through the files pushed ( as I am on my phone at PromCon) and I have noticed you have pushed the Perses docs currently living in the upstream repo.

I would prefer these files be still in the upstream repo as much as possible.
The initial idea was that each repos will bring their own documentation and the website will aggregate the documentations of each repos.

For example, I believe it will make sense to have a documentation relative to the perses-operator and if the doc is NOT living in the perses-operator repo, that would be weird from my opinion.

Also having the doc living in the repo will allow us to version it like it the case today

@agardnerIT agardnerIT mentioned this pull request Sep 14, 2024
@Nexucis
Copy link
Member

Nexucis commented Sep 17, 2024

closing this in favor of #35

@Nexucis Nexucis closed this Sep 17, 2024
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.

New web stack POC
2 participants