qiskit-community / qiskit-metal

Quantum Hardware Design. Open-source project for engineers and scientists to design superconducting quantum devices with ease.
https://qiskit-community.github.io/qiskit-metal/
Apache License 2.0
270 stars 201 forks source link

Set up GitHub Pages and update the About section #984

Closed arnaucasau closed 4 months ago

arnaucasau commented 5 months ago

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 https://github.com/Qiskit/ecosystem/issues/578.

zlatko-minev commented 4 months ago

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

image
zlatko-minev commented 4 months ago

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

arnaucasau commented 4 months ago

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

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 commented 4 months ago

Awesome, thank you! Updated!

arnaucasau commented 4 months ago

Thank you!!