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: Host rustdoc of master on GitHub pages #3126

Merged
merged 14 commits into from Dec 2, 2022

Conversation

umgefahren
Copy link
Contributor

Description

This PR hosts the documentation of the current master branch on GitHub Pages. The URL should be: https://libp2p.github.io/rust-libp2p

I tested the configuration on my repo and it works. You can see the result under: https://umgefahren.github.io/rust-libp2p

Notes

This PR requires a change of settings in the pages tab. The screenshot below shows the correct configuration:

image

Links to any relevant issues

Solving #3125. Sorry for opening so many issues and then immediately providing PRs.

Open Questions

Is the community happy with this.

@umgefahren umgefahren changed the title feat(*): Host master docs .github/workflows: Host master docs Nov 16, 2022
@thomaseizinger thomaseizinger changed the title .github/workflows: Host master docs feat(docs): Host rustdoc of master on GitHub pages Nov 22, 2022
@thomaseizinger thomaseizinger changed the title feat(docs): Host rustdoc of master on GitHub pages feat: Host rustdoc of master on GitHub pages Nov 22, 2022
@thomaseizinger
Copy link
Contributor

LGTM!

I think the changes to the GitHub pages configuration will need to be made over here: https://github.com/libp2p/github-mgmt/blob/0e08ed66ddd586d3f31f98d1aa4cb54e3795737e/github/libp2p.yml#L3962

I got no idea what the correct config looks like. @galargh Can you help here?

@galargh
Copy link
Contributor

galargh commented Nov 23, 2022

LGTM!

I think the changes to the GitHub pages configuration will need to be made over here: https://github.com/libp2p/github-mgmt/blob/0e08ed66ddd586d3f31f98d1aa4cb54e3795737e/github/libp2p.yml#L3962

I got no idea what the correct config looks like. @galargh Can you help here?

Sadly, terraform provider (and because of that - GitHub Management) doesn't support GitHub Actions as a Pages source yet - https://registry.terraform.io/providers/integrations/github/latest/docs/resources/repository#github-pages-configuration.

I made the required changes through the UI in this repo. You should be good to proceed.

@umgefahren
Copy link
Contributor Author

What is missing here? It should be ready to merge from my POV

@mxinden
Copy link
Member

mxinden commented Nov 30, 2022

Only waiting for a green CI at this point. Once green mergify should merge automatically.

Not sure why CI is failing. Will need to take a look.

@mxinden
Copy link
Member

mxinden commented Dec 2, 2022

libp2p-dcutr and libp2p-relay changes seem unrelated. Discussion is here #2647 (comment).

Moving forward here.

@mxinden mxinden merged commit 82a9e2c into libp2p:master Dec 2, 2022
@mxinden mxinden mentioned this pull request Dec 2, 2022
4 tasks
@mxinden
Copy link
Member

mxinden commented Dec 2, 2022

Docs page is fancy. Thanks @umgefahren.

@mxinden
Copy link
Member

mxinden commented Dec 2, 2022

In case you want to draw more attention to it, referencing the page next to the already referenced libp2p docs in the main README.md would be a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants