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

Final updates to documentation & other changes #316

Merged
merged 11 commits into from
Nov 21, 2019

Conversation

desilinguist
Copy link
Member

@desilinguist desilinguist commented Nov 21, 2019

  • Update various links in documentation and some code files.
  • Update installation instructions.
  • Update release process document.
  • Re-pin packages to get ReadTheDocs build to pass. Documentation for this branch available here.
  • Update .gitignore file.

@coveralls
Copy link

coveralls commented Nov 21, 2019

Coverage Status

Coverage remained the same at 91.643% when pulling 860b4c7 on final-updates-to-documentation into 852649c on master.

Copy link
Contributor

@jbiggsets jbiggsets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Copy link
Collaborator

@aloukina aloukina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few minor requests for clarification

@@ -3,38 +3,34 @@ RSMTool Release Process

This process is only meant for the project administrators, not users and developers.

1. Run ``tests/update_files.py`` to make sure that all test data in the new release have correct experiment ids and filenames. If any (non-model) files need to be changed this should be investigated before the branch is released.
1. Run ``python tests/update_files.py`` to make sure that all test data in the new release have correct experiment ids and filenames. If any (non-model) files need to be changed this should be investigated before the branch is released.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The full command would also include arguments --tests and --outputs - by giving python prefix do we imply that this is the actual command rather than reference to a script?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. I will fix this.


10. Once both builds have passed, make a pull request with the release branch to be merged into ``master`` and request code review.
11. Make sure that the RTFD build for ``master`` passes.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RTFD?

Copy link
Collaborator

@aloukina aloukina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@desilinguist desilinguist merged commit 850459f into master Nov 21, 2019
@delete-merged-branch delete-merged-branch bot deleted the final-updates-to-documentation branch November 21, 2019 20:11
srhrshr pushed a commit to srhrshr/rsmtool that referenced this pull request Oct 23, 2021
…ingService/final-updates-to-documentation

Final updates to documentation & other changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants