Image registry and setup update#3233
Merged
georglauterbach merged 7 commits intomasterfrom Apr 10, 2023
Merged
Conversation
georglauterbach
added
area/scripts
area/documentation
meta/feature freeze
georglauterbach
commented
Apr 8, 2023
polarathene
requested changes
Apr 9, 2023
- Remove dynamic support for showing command invoker via `${0}` for `./setup.sh` or `/usr/local/bin/setup`, just show `setup` command.
- Remove bulk of description text that isn't applicable to the `setup` command, but `./setup.sh` only.
- Revised description for help usage, as attempting `setup email help` or similar is not valid. Clarify to user they must be more specific.
- Revised the 2nd example description.
- Changed references of "script" to "CLI" which is now more accurate representation of the `setup` command.
polarathene
requested changes
Apr 9, 2023
| COMMAND ${RED}:=${RESET} { email ${RED}|${RESET} alias ${RED}|${RESET} quota ${RED}|${RESET} dovecot-master ${RED}|${RESET} config ${RED}|${RESET} relay ${RED}|${RESET} debug } SUBCOMMAND | ||
|
|
||
| ${ORANGE}DESCRIPTION${RESET} | ||
| This is the main administration script that you use for all your interactions with |
Member
There was a problem hiding this comment.
If you want to keep some of this description that was removed, you would want to relocate it to setup.sh in some manner, or the docs on setup.sh. I don't think it's relevant anymore to be interleaved into the main setup command help output.
I was not able to provide a web UI suggestion for changes and edited the file myself. The commit message detais:
- Remove dynamic support for showing command invoker via
${0}for./setup.shor/usr/local/bin/setup, just showsetupcommand. - Remove bulk of description text that isn't applicable to the
setupcommand, but./setup.shonly. - Revised description for help usage, as attempting
setup email helpor similar is not valid. Clarify to user they must be more specific. - Revised the 2nd example description.
- Changed references of "script" to "CLI" which is now more accurate representation of the
setupcommand.
Member
There was a problem hiding this comment.
Note that most commands call scripts that will still output ./setup.sh in their help output.
polarathene
approved these changes
Apr 9, 2023
wernerfred
approved these changes
Apr 9, 2023
casperklein
approved these changes
Apr 9, 2023
georglauterbach
removed
the
meta/feature freeze
Contributor
|
Documentation preview for this PR is ready! 🎉 Built with commit: 2311aba |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
Follow up to #3219.
Changes
docker.io/mailserverforghcr.io/docker-mailserver. Therefore updatessetup.shas well. So I figured it's okay to slightly adjust the docs forsetup.shas well.Type of change
Checklist:
docs/)