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

Added publishing to Github pages to for better docs experience #26

Closed
wants to merge 2 commits into from

Conversation

MrDaGree
Copy link
Contributor

@MrDaGree MrDaGree commented Aug 5, 2023

I like being able to click links and Im sure others are too. I figured a good starting point was to ensure Pages is enabled and then do something like this.

A few things I am not sure of and would appreciate some feedback on:

  1. How much do we want to replace links/references to LXD now? Shall we wait until the first release of Incus?
  2. For things like forums/discussion topics, how we do want to link stuff like that in the docs?

Example of the action in my fork as well as a preview

Checks for Documentation will fail due to pages not being created yet

Signed-off-by: Dawson Greeley <dawsonmax10@gmail.com>
Signed-off-by: Dawson Greeley <dawsonmax10@gmail.com>
@github-actions github-actions bot added the Documentation Documentation needs updating label Aug 5, 2023
@MrDaGree MrDaGree changed the title docs: Added publishing to Github pages to for better docs experience Added publishing to Github pages to for better docs experience Aug 5, 2023
@stgraber
Copy link
Member

stgraber commented Aug 5, 2023

We've been having some discussions with @cyphar about how to handle that in the future, we're hoping to be able to provide some more clarity and direction around that early next week.

@stgraber
Copy link
Member

stgraber commented Aug 9, 2023

Right, so what I was referencing above was the whole move of Incus over to the LXC project.
With that done, documentation will be published at https://linuxcontainers.org/incus/doc/main/ similarly to what was done in the LXD times. Same goes for the forum, we'll use https://discuss.linuxcontainers.org.

Closing the PR as we won't be using Github Pages for this, but simply rely on our existing logic to publish the GH actions artifact on the website.

(I expect most of that tooling to be put back in place over the next couple of weeks)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Development

Successfully merging this pull request may close these issues.

None yet

2 participants