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

docs(developing): adapt documentation after infrastructure code split #3679

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

tiborsimko
Copy link
Member

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.

@tiborsimko tiborsimko self-assigned this Sep 20, 2024
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 tiborsimko marked this pull request as ready for review January 27, 2025 14:25
@tiborsimko tiborsimko changed the title docs: adapt documentation after infrastructure code split docs(developing): adapt documentation after infrastructure code split Jan 27, 2025
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
image: registry.cern.ch/cernopendata/cernopendata-portal:0.2.9
image: registry.cern.ch/cernopendata/cernopendata-portal:prod

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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
portal's infrastructure code is living in the sister `cernopendata-portal
portal's infrastructure code is living in the `cernopendata-portal

[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
Copy link
Contributor

Choose a reason for hiding this comment

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

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).

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.

docs: update DEVELOPING guide following infrastructure code split
2 participants