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

Test: import old docs #242

Closed

Conversation

GabiNecasova
Copy link
Collaborator

@GabiNecasova GabiNecasova commented Nov 17, 2023

  • This tries to import Markdown files from docs.podman.io to the podman.io
  • This is just a test, it means almost no modifications of Markdown files, the goal is just to check how does it looks like on podman.io page
  • Note: if a command e.g. podman generate has subcommands ( podman generate systemd, podman generate), then we can create a sidebar category for easier navigation (similar to Docker)
  • Note: The "SEE ALSO" sections of Markdown files are now commented because they cause link error

Screenshot from 2023-11-15 17-58-23
Screenshot from 2023-11-15 17-58-00

- this tries to import Markdown files from docs.podman.io to the
  podman.io
- this is just a test, it means almost no modifications of Markdown
  files, the goal is just to check how does it looks like on podman.io

Signed-off-by: Gabriela Necasova <[email protected]>
@Luap99
Copy link
Member

Luap99 commented Nov 17, 2023

This tries to import Markdown files from docs.podman.io to the podman.io

Not that I am against this but there is one big thing to consider and I am not sure if you are aware of it so will write it down here again:
The docs are based of https://github.com/containers/podman/tree/main/docs/source and it is hard requirement that the source must live in the podman repo, when we make code changes over there we have the requirement that the docs must be updated at the same time. Trying to do this over more than one repo is simply unsustainable and would complicate the work considerably.
Right now the docs are build and published by readthedocs (https://readthedocs.org/projects/podman/). They will automatically update for each merge and provide build for each version. This is important functionality that we would need to replicate if we want this under podman.io/docs. And to me this looks like a lot of work to reinvent readthedocs functionality.

So my first question is what benefit does podman.io/docs has over docs.podman.io? Is it really worth all the effort to solve the requirements mentioned above. If this is only about style then would it not be simpler to change the theme for sphinx build https://github.com/containers/podman/blob/main/docs/source/conf.py#L63-L75 and/or add custom css there?

@GabiNecasova
Copy link
Collaborator Author

@Luap99 Thank you very much for your comments. I didn't know exactly about this complication and I understand. In that case, it is indeed probably the best solution to keep the documentation in the Podman repository and just change the visual style (I think the dark mode is very useful).

@rhatdan
Copy link
Member

rhatdan commented Jan 4, 2024

@GabiNecasova still working on this?

@GabiNecasova
Copy link
Collaborator Author

@rhatdan No, currently I am reviewing the podman.io content and I will make a couple of suggestions.
I think I can close this issue. Thank you for pointing this out.

@GabiNecasova
Copy link
Collaborator Author

I am closing this.

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.

3 participants