search

qiskit-community / qiskit-algorithms

A library of quantum algorithms for Qiskit.
https://qiskit-community.github.io/qiskit-algorithms/
Apache License 2.0
111 stars 54 forks source link

Deploy docs to GitHub Pages #115

Closed arnaucasau closed 8 months ago

arnaucasau commented 9 months ago

Summary

This PR changes the deploy-docs.yml workflow to deploy the documentation to GitHub Pages to migrate the project away from the qiskit.org domain.

More information about the change and a quick guide to set up GitHub pages can be found at: https://github.com/Qiskit/ecosystem/issues/578

Reminder task for maintainers here to update the doc link in the About text for the repo on the main page once this change happens and the docs are re-deployed . This will need backporting to stable to have it apply to present docs version before it can be re-run.

woodsp-ibm commented 9 months ago

FYI for CI failure see issue

woodsp-ibm commented 8 months ago

Once this is done the first section in the README, about installation, will need its link updating.

coveralls commented 8 months ago

Pull Request Test Coverage Report for Build 7492816091

Totals Coverage Status
Change from base Build 7492731210: 0.0%
Covered Lines: 6470
Relevant Lines: 7143
💛 - Coveralls
arnaucasau commented 8 months ago

Great, thank you @woodsp-ibm! Regarding your question, I guess when you say publish it, you mean to qiskit.org, but correct me if I'm wrong.

We only need the first of the two steps you mentioned. With this workflow, the docs will be deployed to GitHub Pages where the documentation will live, and once this change is done, I will set up the redirects from qiskit.org to the GitHub Pages link we have.

woodsp-ibm commented 8 months ago

@arnaucasau I was reading it was "deployed" to a gh-pages branch - maybe thats all that there is to it and its live from there and needs no extra step. Once its backported I'll run the workflow.

arnaucasau commented 8 months ago

Oh, I see what you meant now. Exactly, we only need to deploy to the gh-pages branch, and the publish step is done automatically by a workflow called pages-build-deployment. The only important thing is to set the branch correctly in the settings. Here you can find a short tutorial I wrote: https://github.com/Qiskit/ecosystem/issues/578#issuecomment-1858033321

woodsp-ibm commented 8 months ago

@arnaucasau Ok, I ran the workflow, updated the Settings and the docs are now live https://qiskit-community.github.io/qiskit-algorithms/ I guess a redirect for former ecosystem url can be done now.