#92 Taskotron 0.1 Release Prep
Closed: Fixed None Opened 9 years ago by tflink.

Prepare for release of Taskotron 0.1:
* upload release tarballs to qadevel.cloud.fedoraproject.org
* merge code into master for all related projects:
* libtaskotron
* resultsdb, resultsdb_frontend, resultsdb_api
* pytap13
* create more permanent repos
* build documentation and upload to rtd
* announce release


build documentation and upload to rtd

There are some important instructions in readme.rst which are not mentioned in our generated docs. Could we somehow include and link readme.rst from docs/source/index.rst? Maybe we can symlink the file to that directory and then use reST linking? I'm not familiar this part of reST functionality yet.

Other than the installation instructions, what is missing in the generated docs?

I suppose that another way to handle this would be to change the actual readme to have a link to the online docs and point to the corresponding local docs directory instead of duplicating everything.

Yes, the installation instructions are quite important. If somebody visits our documentation, he should see everything necessary there, and shouldn't need to look for other pieces elsewhere. I assume this particular person just followed our wiki page and visited the documentation site, he/she hasn't visited the project repository neither cloned it.

Sure, I'm not arguing about what's important or not, I'm just wondering if there's something you've noticed that I haven't.

On a related note, the docs I'm working on for #159 are going to include some installation instructions. I should have them ready for review by the end of the day.

Here's some solution - either a symlink or a rst include directive:
http://stackoverflow.com/questions/10199233/can-sphinx-link-to-documents-that-are-not-located-in-directories-below-the-root

We have a nice concise readme, it would be a shame not to include it in the documentation as a quick reference page.

code is merged and tagged, tarballs uploaded to qadevel, builds done on copr

removed the bit about more permanent repos. things are changing fast still and we don't have ci yet. copr is going to remain an easier way to install things

stg has been updated, all release tasks are complete

Login to comment on this ticket.

Metadata