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

Add descriptions (minimal docs) to ui #266

Closed
anbraten opened this issue Aug 17, 2021 · 0 comments · Fixed by #245
Closed

Add descriptions (minimal docs) to ui #266

anbraten opened this issue Aug 17, 2021 · 0 comments · Fixed by #245
Labels
enhancement improve existing features ui frontend related
Milestone

Comments

@anbraten
Copy link
Member

anbraten commented Aug 17, 2021

Problem

There are currently quite some options inside the settings without any description. Only place you "could" eventually find descriptions for these settings is in the documentation.

Repo settings

Screenshot from 2021-08-18 00-39-42

For example Project Visibility Internal vs Private could be unclear to users.

Registries

Add some info box what registries / secrets are and how they effect your CI.

Screenshot from 2021-08-18 00-52-31

For example for secrets:

Secrets are exposed to your pipeline steps and plugins as uppercase environment variables and 
can therefore be referenced in the commands section of your pipeline.
A secret with the name `test` would be accessible as `TEST` inside your CI step. 
Have a look to the [docs](...) for more information.

Suggestion

To keep things simple and to not need to find the correct place in the docs, I would suggest to add some kind of description explaining each option to all possible places where settings are used.

Example for Project Settings > Protected:

Screenshot from 2021-08-18 00-39-42

@anbraten anbraten changed the title Add descriptions to (repo) settings Add descriptions to ui Aug 17, 2021
@anbraten anbraten changed the title Add descriptions to ui Add descriptions (minimal docs) to ui Aug 17, 2021
@anbraten anbraten mentioned this issue Sep 18, 2021
58 tasks
@anbraten anbraten added ui frontend related enhancement improve existing features labels Sep 19, 2021
@anbraten anbraten added this to the 0.15.0 milestone Sep 23, 2021
@6543 6543 closed this as completed in #245 Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement improve existing features ui frontend related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant