docs(developing): adapt documentation after infrastructure code split #3679
Conversation
tiborsimko
changed the title
| @@ -30,7 +30,7 @@ services: | |||
| - TEMPLATES_AUTO_RELOAD=True | |||
| command: bash -c "/content/scripts/start-server-debug.sh" | |||
| restart: "unless-stopped" | |||
| image: registry.cern.ch/cernopendata/cernopendata-portal:0.2.5 | |||
| image: registry.cern.ch/cernopendata/cernopendata-portal:0.2.9 | |||
There was a problem hiding this comment.
| image: registry.cern.ch/cernopendata/cernopendata-portal:0.2.9 | |
| image: registry.cern.ch/cernopendata/cernopendata-portal:prod |
There was a problem hiding this comment.
Perhaps there is a container image tag called prod, but there is no such git tag in the cernopendata-portal repository. That could be problematic; recall that we have been using latest in the past, and had to stop it due to local installation being broken. This is what lead to using 0.1.11 docker image in the sources here, with occasional update to later stable versions.
I therefore prefer to use concrete versions (which exist as both git tags and docker image versions, and which are immutable) over something like latest or prod (which is mutable and which does not exist as a tag or a branch).
README.rst
Outdated
| This repository is part of for the `CERN Open Data portal | ||
| <https://opendata.cern.ch>`_, hosting the source versions of the content, | ||
| notably data records and associated documentation pages. The CERN Open Data | ||
| portal's infrastructure code is living in the sister `cernopendata-portal |
There was a problem hiding this comment.
| portal's infrastructure code is living in the sister `cernopendata-portal | |
| portal's infrastructure code is living in the `cernopendata-portal |
There was a problem hiding this comment.
Removed here and in two other places in the developing guide.
| [remote "upstream"] | ||
| url = [email protected]:cernopendata/opendata.cern.ch | ||
| fetch = +refs/heads/*:refs/remotes/upstream/* | ||
| fetch = +refs/pull/*/head:refs/remotes/upstream/pr/* | ||
|
|
||
| Understanding repository branches |
There was a problem hiding this comment.
Before the section of the repository branches, it would be nice to have a section with the repository structure, explaining the difference between the different folders (in particular the one of the skeletons).
There was a problem hiding this comment.
Added Appendix A explaining the repository structure, and also added Appendix C explaining the git conventional commit style (that is now being checked by the CI).
tiborsimko
force-pushed
the
3678-docs
branch
2 times, most recently
from
977fb4b to
a661da9
Compare
Adapts documentation for data curators following up the split of the portal's infrastructure code from the content in two repositories. Implements comments from the cernopendata#3590 pull request review. Upgrades the `cernopendata-portal` image version to 0.2.9. Closes cernopendata#3678.
tiborsimko
force-pushed
the
3678-docs
branch
from
a661da9 to
0f99b6b
Compare
Adapts documentation for data curators following up the split of the
portal's infrastructure code from the content in two repositories.
Implements comments from the #3590 pull request review.
Closes #3678.