-
Notifications
You must be signed in to change notification settings - Fork 7.2k
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
CI - no absolute links to local pages #849
Conversation
Deploy preview ready! Built with commit 1a70494 |
045c025
to
3e9cd5a
Compare
1a70494
to
c5fcc1d
Compare
7f06e48
to
ffbdaaf
Compare
Checks have passed! :) I would like to start working on new tests for relative links to missing resources and potential redirect loops. Also, don't you think it's time to enforce tests on master? Almost all PRs to master branch with no Jenkinsfile have been merged. And I would gladly drop comments in the remaining ones to ask for rebase. Thanks! |
@johndmulhausen that PR is good to go! 😊 |
lgtm |
@friism thanks! :) |
@aduermael Right now the CI is failing due to a submodules error:
I think |
@johndmulhausen Yes, Go deps are now vendored as submodules (you asked me to do it). |
cde5c50
to
db2565e
Compare
It's great that we're gonna use submodules, thanks for that. Sorry it's creating this problem. Other than that, this PR is looking good. :) @mstanleyjones also did a pass at getting rid of old PRs so we should be able to turn on mandatory Jenkins very soon, though there are a couple bugs that need to be addressed first:
|
66ada90
to
dae6b14
Compare
I fixed the issue with submodules, but meanwhile, new absolute links to docs.docker.com have been introduced... I'm fixing that. |
Yay! All checks have passed! 🙂 |
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
This reverts commit ca54f76. We want to fix the root cause, not the symptoms. So let’s make sure original content is fine instead of fixing it at build. Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
Signed-off-by: Adrien Duermael <adrien@duermael.com>
6ffc555
to
5e3fbb8
Compare
@@ -82,7 +82,7 @@ enabled](troubleshoot.md#virtualization-must-be-enabled) in Troubleshooting. | |||
<p /> | |||
* Nested virtualization scenarios, such as running Docker for Windows on a VMWare or Parallels instance, might work, but come with no guarantees (i.e., not officially supported). | |||
<p /> | |||
* **What the Docker for Windows install includes**: The installation provides [Docker Engine](https://docs.docker.com/engine/userguide/intro/), Docker CLI client, [Docker Compose](https://docs.docker.com/compose/overview/), and [Docker Machine](https://docs.docker.com/machine/overview/). | |||
* **What the Docker for Windows install includes**: The installation provides [Docker Engine](/engine/userguide/intro/), Docker CLI client, [Docker Compose](/compose/overview/), and [Docker Machine](/machine/overview/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not introduced here, but shouldn't this be a link to a .md file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mstanleyjones I have no idea... 😕
@@ -478,15 +478,15 @@ You can configure options on the Docker daemon in the given JSON configuration f | |||
|
|||
![Docker Daemon](images/docker-daemon.png) | |||
|
|||
For a full list of options on the Docker daemon, see <a href="https://docs.docker.com/engine/reference/commandline/dockerd/" target="_blank">daemon</a> in the Docker Engine command line reference. | |||
For a full list of options on the Docker daemon, see [daemon](/engine/reference/commandline/dockerd/) in the Docker Engine command line reference. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You changed the functionality of this link by removing the target attribute...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mstanleyjones I can use this syntax with Kramdown: [link](url){:target="_blank"}
I'll fix it now.
|
||
In that topic, see also: | ||
|
||
* [Daemon configuration file](https://docs.docker.com/engine/reference/commandline/dockerd/#/daemon-configuration-file) | ||
* [Daemon configuration file](/engine/reference/commandline/dockerd/#/daemon-configuration-file) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not introduced here, but these should point to the .md file if possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mstanleyjones I can fix it if you're sure we should always link to md files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mstanleyjones well if I do this the redirect loses the anchor link. You can try by yourself:
https://docs.docker.com/engine/reference/commandline/dockerd/#/daemon-configuration-file
versus
https://docs.docker.com/engine/reference/commandline/dockerd.md#/daemon-configuration-file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The correct Markdown should be:
[Daemon configuration file](/engine/reference/commandline/dockerd.md#daemon-configuration-file)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mstanleyjones https://docs.docker.com/engine/reference/commandline/dockerd.md#daemon-configuration-file doesn't work either...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe it expects relative URLs; ../engine/reference/commandline/docker.md#daemon-configuration-file
?
@@ -37,7 +37,7 @@ For a complete list of `docker-machine` subcommands, see the [Docker Machine sub | |||
|
|||
Users using their own Docker Registry will experience `x509: certificate signed by unknown authority` | |||
error messages if their registry is signed by custom root Certificate Authority and it is | |||
not registered with Docker Engine. As discussed in the [Docker Engine documentation](https://docs.docker.com/engine/security/certificates/#/understanding-the-configuration) | |||
not registered with Docker Engine. As discussed in the [Docker Engine documentation](/engine/security/certificates/#/understanding-the-configuration) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As above, link to the .md if possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mstanleyjones Same as above... Losing the anchor link
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mstanleyjones Also, one important point. Currently it is somehow better to use a path of this form: https://docs.docker.com/engine/reference/commandline/dockerd/
Instead of https://docs.docker.com/engine/reference/commandline/dockerd.md
Because the non-md form leads you right to the page you want. While the md form returns a terrible 404 error with a client side JS script that takes you to the non-md path...
We already mentioned that in the past, I really think it's an issue for SEO.
But I also think it makes more sense to link to local markdowns within markdowns. Maybe we should just update these links at build time.
Signed-off-by: Adrien Duermael <adrien@duermael.com>
as requested by @mstanleyjones Signed-off-by: Adrien Duermael <adrien@duermael.com>
@mstanleyjones I added the missing Please merge that PR as soon as possible, I don't want absolute links to be re-introduced. |
@mstanleyjones @johndmulhausen Also, the Jenkins tests should be made required now. Please please please... |
@mstanleyjones about that issue with links that should point to actual markdowns. I'm totally on board with this idea. |
thank you @mstanleyjones 🙂 |
UCP storage requirements update
Describe the proposed changes
New tests to make sure there are no absolute links to
docs.docker.com
in local pages.makes sure all local pages referenced by links do exist (and not though redirects)makes sure all redirects point to existing pagesedit: I'll take care of relative links checking in a different PR.
work in progress...