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

Set up GitHub Pages and update the About section #984

Closed
arnaucasau opened this issue Feb 5, 2024 · 5 comments
Closed

Set up GitHub Pages and update the About section #984

arnaucasau opened this issue Feb 5, 2024 · 5 comments
Labels
enhancement New feature or request

Comments

@arnaucasau
Copy link
Contributor

arnaucasau commented Feb 5, 2024

Instructions

The project now has the documentation deployed in a branch called gh-pages, but we need to set up the repo to use GitHub Pages by following the next 5 steps. Once the GitHub Pages is set up please update the repo's About section to display the new link.

  1. Navigate to your site's repository
  2. Click Settings
  3. Go to Pages
  4. Select Deploy from a branch, under the Source section on Build and deployment
  5. Select the gh-pages branch and the / (root) folder in the Branch section on Build and deployment

GitHubPages-example

The default URL where you can find your site is https://qiskit-community.github.io/qiskit-metal

For further information, you can see the GitHub Pages Quickstart and Qiskit/ecosystem#578.

@arnaucasau arnaucasau added the enhancement New feature or request label Feb 5, 2024
@arnaucasau arnaucasau changed the title Set up GitHub Pages Set up GitHub Pages and update the About section Feb 6, 2024
@zlatko-minev
Copy link
Collaborator

Thank you! Ok, so i just did this, what's next
image

@zlatko-minev
Copy link
Collaborator

We will want to merge this branch in the main sometime?

@arnaucasau
Copy link
Contributor Author

Thank you @zlatko-minev! The page is now working at https://qiskit-community.github.io/qiskit-metal 🎉

No need to merge the branch, the gh-pages branch contains the docs built, and thanks to the new workflow it will be updated at each push to the main, similar to how we deployed to qiskit.org before :)

The only thing left in the issue is to change the link in the About section of the repo to show the new one.

Captura desde 2024-02-07 15-06-03

P.S. If someday you want to deploy the docs from a stable version, the deployment changes introduced in this commit will need to be backported

@zlatko-minev
Copy link
Collaborator

Awesome, thank you! Updated!

@arnaucasau
Copy link
Contributor Author

Thank you!!

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

No branches or pull requests

2 participants