GRIDEDIT-1421: Improve_documentation #35
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ahmad-el-sayed
requested changes
Oct 2, 2024
|
|
||
| To display the usage, use | ||
|
|
||
| ```bash | ||
| ./scripts/automation/release.sh --help | ||
| ``` | ||
| The file `./scripts/globals.sh` contains global variables used across all scripts. To work with test branches |
There was a problem hiding this comment.
The forked repositories must be removed, particularly private ones, and so are the associated TeamCity sub-projects. They clutter the parent project. It does not make sense to leave there forever. They were there for development purposes.
Also notice that that the jobs that generate nupkgs from the forks, have the exact same name prefixes as the real nupkgs, and end up in the package repository. That's bad. They are visible in visual studio through the nuget manager.
Comment on lines
+27
to
+31
| The scripts clone Git repositories using SSH. To use SSH with `git clone`, you must set up SSH keys in your | ||
| GitHub account under **Settings** > **SSH and GPG keys**. | ||
| Additionally, Single Sign-On (SSO) must be configured for the key to authorize the Deltares and Deltares-Research organizations. | ||
|
|
||
| GitHub tokens can be managed under **GitHub account** > **Developer settings** > **Personal access tokens** (classic). When generating a new token, ensure that SSO is configured to authorize Deltares and Deltares-Research. |
There was a problem hiding this comment.
This can be moved to dedicated section, "Requirements". The section should address 3 things:
- GitHub ssh key ad access token (above)
- TeamCity token
- PyPi token
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.