qiskit documentation about qiskit-metapackage HOT 6 CLOSED

@atilag and @chriseclectic to get the docs for aer going you only really need an overview as you have the contributing and the release notes and two tutorials.

from qiskit-metapackage.

@pistoia how does this simplifying of documentation process change your current docs in aqua and chemistry.

from qiskit-metapackage.

@jaygambetta Right now the process of generating the documentation of Qiskit Aqua and Qiskit Chemistry is somewhat convoluted because we wanted to merge the two documentation trees into one in spite of them coming from two separate repositories (see https://github.com/Qiskit/qiskit-aqua/blob/master/docs/README.md). I think this process is going to simplify and unify everything so it's good.

from qiskit-metapackage.

diego can you set up the documentation building and automation in this repo for an overview and install

I added the first bit (building locally via make doc at #16). For the automation, I think we need to refine the flow with the help of other people involved (basically decide how the different projects "plug" their documentation into the main one). Which brings me to ...

@abdonrd and @diego-plan9 is it better we push from qiskit-foo to this repo and then when this repo passes it pushes to qiskit.org so that the https://qiskit.org/documentation/foo is just a folder in here or to have multiple ci going to the qiskit.org repo. I would prefer the push here so that we can do a make doc in this repo and check out the documentation before it is pushed to the qiskit.org site

I'd basically be happy with whichever @abdonrd finds more convenient, as it seems mostly a deployment question! I do like the idea of having all the updates to the "live" documentation centralized somewhere (as in, in this repo, for example) as you mention.

My main question is how do you see the flow for each project's documentation team: would they always work against this repository, making changes to the files here directly; or on the contrary keep working on the documentation on each individual repo and we come up with some means of "retrieving those changes automatically"? I can see arguments for both 😬

from qiskit-metapackage.

I don’t know why if we move it all here we even need it in the other repositories. Look at tensorflow

https://github.com/tensorflow/tensorflow/tree/master/tensorflow/docs_src

We could do the same with a readme going here.

The problem with that is how do we auto generate the sdk.

I would like only one place and then auto updating for the rest.

from qiskit-metapackage.

I am closing this as we have the documentation in this repo now.

from qiskit-metapackage.