Rename and Document *GLOBAL* Public Deploy Keys
Unless I'm missing it, the documentation needs to be updated for the Deploy Keys that can be added globally to an entire GitLab install.
I believe this document: https://docs.gitlab.com/ce/ssh/README.html#deploy-keys should be updated with the below text.
I tried to fork the repository and do a pull request for this update, but gitlab can't seem to successfully complete the fork process for the gitlab-ce repository.
I would also like to submit the idea that the nomenclature for these keys NOT include the word "public" for two reasons:
- It can be confused with the general idea of a "Public" ssh key (when I am thinking "public" in this context is meant to indicate "global" usability by all projects in the GitLab install)
- In GitLab's own nomenclature "Public" repositories are visible outside one's organization - so it adds some hesitation that this key might somehow be exposed or usable to individuals outside of the organization that the gitlab installation was stood up for.
I favor "Global" - but anything that does not include "Public" would be helpful.
So far it seems only this heading text uses the "public" nomenclature: 'Public deploy keys available to any project'
Side note: I dislike conditional UI because it sabotages discoverability - would be nice if the 'Public deploy keys available to any project' heading ALWAYS appeared even when there are no Global Keys configured (with "none" under it) - then it cues everyone up that this functionality is present - they just have to find where to set it up.
FYI - part of the reason I hate these 'little' ambiguities is that I am responsible for running Gitlab-ce as a service inside a company I will have to field questions created by such ambiguities.
Documentation Edits:
- Rename section "Deploy Keys" to "Repository Deploy Keys"
- Add the following section under that one:
## Global Deploy keys
Global Deploy keys allow read-only or read-write (if enabled) access to one or
multiple projects in the entire GitLab installation.
This is really useful for cloning repositories to shared Continuous
Integration (CI) services. GitLab administrators can setup the key in GitLab
and any shared CI systems and then project masters and owners can add the
Global Deploy key to their project to give access to the shared CI.
GitLab administrators setup Global Deploy keys in the admin area under the
section 'Deploy Keys'. Ensure keys have a meaningful title as that will be
the only way for Project masters and owners to identify the correct Global
Deploy key to add.
Once a GitLab administrator adds the Global Deployment key, project masters
and owners can add it in project settings under the section 'Repository' by
expanding the 'Deploy Key' section and clicking 'Enable' next to the
appropriate key listed under 'Public deploy keys available to any project'
Note: The heading 'Public deploy keys available to any project' only appears
if there is at least one Global Deploy Key configured.
Global Deploy keys can be shared between projects, you just need to add them
to each project.