hyperlink to relevant docs & licenses #1368
Conversation
Hey @katrinleinweber thank you for the contribution :) I can merge this if you fix the links to relative URL to the sphinx docs. |
@@ -28,14 +28,14 @@ Co-develop Zenodo | |||
----------------- | |||
Are you missing a feature in Zenodo? Why not help us built the feature. We are | |||
happy to receive both tiny and large contributions to Zenodo. Have a look at | |||
our Development Process and Project Life Cycle and don't hesitate to get in | |||
our `Development Process <https://github.com/zenodo/zenodo/blob/master/docs/development/process.rst>`_ and `Project Life Cycle <https://github.com/zenodo/zenodo/blob/master/docs/development/projectlifecycle.rst>`_ and don't hesitate to get in |
krzysztof
Dec 12, 2017
•
Contributor
Since this is documentation, perhaps it would be better if those two links resolved to the compiled docs, and not the GitHub source files? Moverover, since we might move from readthedocs to another service at some point use relative link to a "label" instead of absolute readthedocs URL, see: https://stackoverflow.com/questions/37553750/how-can-i-link-reference-another-rest-file-in-the-documentation
Since this is documentation, perhaps it would be better if those two links resolved to the compiled docs, and not the GitHub source files? Moverover, since we might move from readthedocs to another service at some point use relative link to a "label" instead of absolute readthedocs URL, see: https://stackoverflow.com/questions/37553750/how-can-i-link-reference-another-rest-file-in-the-documentation
katrinleinweber
Dec 12, 2017
Author
Contributor
Like this v
? When a Markdown fangirl encounters reST ;-D
Like this v
? When a Markdown fangirl encounters reST ;-D
krzysztof
Dec 12, 2017
Contributor
Almost :-)
Almost :-)
CONTRIBUTING.rst:29: WARNING: Inline interpreted text or phrase reference start-string without end-string.
@@ -28,7 +28,7 @@ Co-develop Zenodo | |||
----------------- | |||
Are you missing a feature in Zenodo? Why not help us built the feature. We are | |||
happy to receive both tiny and large contributions to Zenodo. Have a look at | |||
our `Development Process <https://github.com/zenodo/zenodo/blob/master/docs/development/process.rst>`_ and `Project Life Cycle <https://github.com/zenodo/zenodo/blob/master/docs/development/projectlifecycle.rst>`_ and don't hesitate to get in | |||
our :ref:`development_process_` and :ref:`project_life_cycle`and don't hesitate to get in |
krzysztof
Dec 12, 2017
Contributor
the labels have to match, e.g. _project_life_cycle
and _development_process
. Please compile it locally and verify that the docs indeed build and the links works (see ./run-tests.sh
which builds it like this: sphinx-build -qnNW docs docs/_build/html
)
the labels have to match, e.g. _project_life_cycle
and _development_process
. Please compile it locally and verify that the docs indeed build and the links works (see ./run-tests.sh
which builds it like this: sphinx-build -qnNW docs docs/_build/html
)
katrinleinweber
Dec 12, 2017
Author
Contributor
OK, will try. I presume the "Coverage decreased" can be ignored.
OK, will try. I presume the "Coverage decreased" can be ignored.
krzysztof
Dec 12, 2017
Contributor
Yes, the coverage dropped because the tests failed. Also make sure to rebase to master branch.
Yes, the coverage dropped because the tests failed. Also make sure to rebase to master branch.
katrinleinweber
Dec 12, 2017
Author
Contributor
That's the one I branched off from this morning. At least one correct intuition ;-) Thanks for helping me get started with reST!
That's the one I branched off from this morning. At least one correct intuition ;-) Thanks for helping me get started with reST!
krzysztof
Dec 12, 2017
Contributor
The master branch has changed since
The master branch has changed since
@@ -28,7 +28,7 @@ Co-develop Zenodo | |||
----------------- | |||
Are you missing a feature in Zenodo? Why not help us built the feature. We are | |||
happy to receive both tiny and large contributions to Zenodo. Have a look at | |||
our :ref:`development_process_` and :ref:`project_life_cycle` and don't hesitate to get in | |||
our :ref:`development_process` and :ref:`project_life_cycle` and don't hesitate to get in |
krzysztof
Dec 12, 2017
Contributor
I think those two should have leading underscores. Please compile locally and test.
I think those two should have leading underscores. Please compile locally and test.
krzysztof
Dec 12, 2017
Contributor
Ignore comment above, looks good.
Ignore comment above, looks good.
Thanks a lot! |
I thank you for helping me get started with reST :-) |
No description provided.