docs: using standard OS tabs for registries docs #4497
Conversation
Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
themr0c
requested review from
dgolovin and
feloy
and removed request for
a team
|
This check is no good. Starting references to images with |
| @@ -0,0 +1,37 @@ | |||
| #### Prerequisites | |||
|
|
|||
| - Podman. | |||
There was a problem hiding this comment.
I assume it needs to be running? Before the change that was required, and there is a restart in the steps.
There was a problem hiding this comment.
It only needs to be installed. You need to restart any podman process if it exists. I will clarify.
|
I don't see why we add 2 new files (linux / windows) that are only included by one file. why not keep the existing file (not extracting the content) |
|
@benoitf for clarity and readability, I find it preferable to decouple the presentation layer (tabs) from the content (snippets). I plan to generalize this approach in every page containing tabs. I have not done that before only because previously, I was not familiar with the concept of "snippets" in Docusaurus. |
website/docs/working-with-containers/registries/_insecure-registry-linux.md
Outdated
Show resolved
Hide resolved
…stry-linux.md Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
| 1. Restart Podman. | ||
|
|
||
| ```shell-session | ||
| $ sudo systemctl restart podman | ||
| ``` |
There was a problem hiding this comment.
The "restart Podman" steps in various Linux procedures (here, proxy) are inconsistent and mostly irrelevant. It deserves its own issue.
| insecure = true | ||
| ``` | ||
|
|
||
| If you have multiple registries, you can add one `[[registry]]` block per registry: |
| 1. Open `registries.conf`. | ||
|
|
||
| ```shell-session | ||
| $ sudo vi /etc/containers/registries.conf |
There was a problem hiding this comment.
Isn't it in openshift docs / standards that sudo commands use # / comment out feature so it's not accidently copied-and-pasted? unsure if we should apply this here / other parts of PD documentation.
There was a problem hiding this comment.
# command for a command by root. But usually people don't understand.
$ sudo command is correct, as you execute in the user context (sudo does the privilege escalation). Less prone to error because user forget to get root.
|
|
||
| 1. Click "Yes" to the insecure registry warning. | ||
|
|
||
|  |
There was a problem hiding this comment.
false positive on vale issue?
There was a problem hiding this comment.
Bad rule. I opened an issue. And am currently lost in regex: do not match strings starting by img/. The /docs... notation breaks the build...
| $ sudo vi /etc/containers/registries.conf | ||
| ``` | ||
|
|
||
| 1. Add the insecure registry: Add a new `[[registry]]` section for the URL of the insecure registry you want to use. For example, if your insecure registry is located at `http://registry.example.com`, add the following lines: |
|
|
||
| If you have multiple registries, you can add one `[[registry]]` block per registry. | ||
|
|
||
| 1. Save and exit the file. |
There was a problem hiding this comment.
I don't think we need this step as it's implied by editing the file you save and exit.
There was a problem hiding this comment.
That was already in the content. I changed as little content as possible. This might require a new pr with new scope.
|
I still have some comments on this PR @themr0c |
Just to be upfront, I was also uncomfortable with the separation but let it go b/c I thought 'it's just one doc' and I like the user-side of the change. When I saw Florent's comments I realized I was wrong, but by then this was already merged. I definitely do not think it is a good idea to use imports for every page with tabs - imports should be rare, and only for cases where one file is getting unmanageable or it actually makes sense for the same content to appear in two places. Why? First, it will make it harder for anyone else to contribute to docs, because it's harder to find things without searching, and having to spend extra time to understand the structure and how and where the content is going to appear, follow links, etc. Second, with 4x the files it would be harder to maintain, rename/move topics, slower to review PRs, etc for the same reasons. |
What does this PR do?
Screenshot/screencast of this PR
What issues does this PR fix or reference?
Standardize navigation.
How to test this PR?