Remove outdated information - #5218
Conversation
There was a problem hiding this comment.
@diitaz93 What do you think of this change? Do you thing the other headings except Description and added/changed/fixed are useful?
…o 5217-clean-up-documentation
|
diitaz93
left a comment
diitaz93
left a comment
There was a problem hiding this comment.
I like the cleaning! 🧹 I would like to keep some of the deployment snippets though
| ```shell | ||
| bash /home/proj/production/servers/resources/hasta.scilifelab.se/update-tool-stage.sh -e S_cg -t cg -b [THIS-BRANCH-NAME] -a | ||
| ``` |
There was a problem hiding this comment.
I use this shortcut very often; it would be great to keep it somehow. Maybe the rest of the items in this section can go.
| ### How to test | ||
|
|
||
| - [ ] Do ... | ||
|
|
||
| ### Expected test outcome | ||
|
|
||
| - [ ] Check that ... | ||
| - [ ] Take a screenshot and attach or copy/paste the output. |
There was a problem hiding this comment.
I'm ok with removing this. Maybe we could add a section reminding us to paste test results in the comments, hiding sensitive information, but if you find it superfluous, let's just remove it
| @@ -1,1821 +0,0 @@ | |||
| # Change Log | |||
There was a problem hiding this comment.
but I agree to remove this; we could find a better way of doing this if we find it necessary
| ```shell | ||
| bash /home/proj/production/servers/resources/hasta.scilifelab.se/update-tool-stage.sh -e S_cg -t cg -b [YOUR-BRANCH-NAME] -a | ||
| ``` | ||
| ### Deploy APP |
There was a problem hiding this comment.
I would like some instructions on how to deploy to the VMs manually. They don't need to be here, but maybe there should be a link to a page in Atlas here (a page that currently does not exist)
| 1. ssh to the login-node | ||
| 2. Install your branch | ||
| ```shell | ||
| bash /home/proj/production/servers/resources/hasta.scilifelab.se/update-tool-stage.sh -e S_cg -t cg -b [YOUR-BRANCH-NAME] -a |
There was a problem hiding this comment.
I would like this file to concern only the deployment of master, and leave deployment instructions for testing purposes somewhere else. I use this snippet (containing master) very often, so I would like to keep it if possible
| bash /home/proj/production/servers/resources/hasta.scilifelab.se/update-tool-prod.sh -e P_cg -t cg -b master -a | ||
| ``` | ||
| ### Deploy APP | ||
| 1. Use the action **[Deploy release to production environment](https://github.com/Clinical-Genomics/cg/actions/workflows/deploy_prod.yml)** to deploy your branch. Make sure to provide the **release-tag** and NOT master to the action. |
There was a problem hiding this comment.
It is not clear that we have to use the "v" when specifying the tag (in trailblazer we shouldn't)
| 1. Use the action **[Deploy release to production environment](https://github.com/Clinical-Genomics/cg/actions/workflows/deploy_prod.yml)** to deploy your branch. Make sure to provide the **release-tag** and NOT master to the action. | |
| 1. Use the action **[Deploy release to production environment](https://github.com/Clinical-Genomics/cg/actions/workflows/deploy_prod.yml)** to deploy your branch. Make sure to provide the **release-tag** and NOT master to the action. (e.g. `v80.2.15`) |
| the title if not. | ||
|
|
||
|
|
||
| 4. Append version increment value `( major | minor | patch )` to specify what kind of release is to be created. |
There was a problem hiding this comment.
maybe we should keep this information somewhere
2 participants
Description
This PR removes outdated documentation as well as trims down the pull request template
Changed