The Wayback Machine - https://web.archive.org/web/20210204012440/https://github.com/zenodo/zenodo/pull/1368
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hyperlink to relevant docs & licenses #1368

Merged
merged 5 commits into from Dec 13, 2017
Merged

Conversation

@katrinleinweber
Copy link
Contributor

@katrinleinweber katrinleinweber commented Dec 12, 2017

No description provided.

Copy link
Contributor

@krzysztof krzysztof left a comment

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

This comment has been minimized.

@krzysztof

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

This comment has been minimized.

@katrinleinweber

katrinleinweber Dec 12, 2017
Author Contributor

Like this v? When a Markdown fangirl encounters reST ;-D

This comment has been minimized.

@krzysztof

krzysztof Dec 12, 2017
Contributor

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

This comment has been minimized.

@krzysztof

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)

This comment has been minimized.

@katrinleinweber

katrinleinweber Dec 12, 2017
Author Contributor

OK, will try. I presume the "Coverage decreased" can be ignored.

This comment has been minimized.

@krzysztof

krzysztof Dec 12, 2017
Contributor

Yes, the coverage dropped because the tests failed. Also make sure to rebase to master branch.

This comment has been minimized.

@katrinleinweber

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!

This comment has been minimized.

@krzysztof

krzysztof Dec 12, 2017
Contributor

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

This comment has been minimized.

@krzysztof

krzysztof Dec 12, 2017
Contributor

I think those two should have leading underscores. Please compile locally and test.

This comment has been minimized.

@krzysztof

krzysztof Dec 12, 2017
Contributor

Ignore comment above, looks good.

Krzysztof Nowak
@krzysztof krzysztof merged commit ba9c37e into zenodo:master Dec 13, 2017
2 checks passed
2 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 84.78%
Details
@krzysztof
Copy link
Contributor

@krzysztof krzysztof commented Dec 13, 2017

Thanks a lot! 👍

@katrinleinweber
Copy link
Contributor Author

@katrinleinweber katrinleinweber commented Dec 13, 2017

I thank you for helping me get started with reST :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants