Adding mkdocs #247
Adding mkdocs #247
Conversation
daviddavis
force-pushed
the
mkdocs
branch
3 times, most recently
from
572d03a
to
3377747
Compare
|
we use mkdocs on pulp-installer and pulp-operator, which links are not working? |
|
I'm currently symlinking the README.md at I think I should maybe break up README.md into files like |
we did something similar on the installer on the installer, all roles are symlinked, here is an example of pulp_all_services Readme.md referring to pulp_services: |
|
@pulp/cli I fixed the links. Please test this out and let me know what you think. To look at the docs, check out this PR and run |
| * Redirecting from `http` to `https`, as done by a typical Pulp installation, | ||
| does not work properly with `POST` and `PUT` requests. | ||
| Please use `https://` in the base url. | ||
| Note that the attempt to use `http` leaks sensitive data over an unencrypted connection. |
There was a problem hiding this comment.
FYI, I dropped this. I don't think it's an issue anymore since we don't follow redirects.
There was a problem hiding this comment.
So what happens now, if you try to use the wrong schema?
There was a problem hiding this comment.
You get a connection error.
There was a problem hiding this comment.
^ That's if there's no redirect.
If there's a redirect, then users receive this error
|
I like it! Maybe we do not want to put the releaseing guide out there... |
|
@pulp/cli it looks like both pulp_installer and pulp-operator are using mkdocs as well but they just publish to https://readthedocs.org/. I could set that up and it would be a lot less work than using docs.pulpproject.org. However, I feel like the latter is a better location. Thoughts? |
We're trying to deprecate/remove all readthedocs and consolidate on docs.pulpproject, yeah? I'd like everything to be in one place. |
[noissue]
[noissue]
daviddavis
force-pushed
the
mkdocs
branch
2 times, most recently
from
ef407e7
to
3ad554b
Compare
|
Ok, I updated the release workflow. I manually ran the publish docs script as well: |
Here's an option to build and publish our docs. Feedback welcome. If this looks good, I can work on a github action workflow to publish our docs to docs.pulpproject.org.
Also, one thing I need to figure out is how to get the links working.