Fixup new docs #701
Fixup new docs #701
Conversation
|
@pedro-psb Thanks for the link. Can you review this and see if I am missing anything big? I checked everything out and besides the issue I filed (pulp/pulp-docs#63), everything seems to be working and looking good. |
There was a problem hiding this comment.
The link within the site should use the (site:abs-path) pattern, as here.
The problem of using the real domain name is that when testing your local changes you could end up leaving your local server by accident, which could be confusing.
staging_docs/index.md
Outdated
| * Reference | ||
| * [Settings](https://pulpproject.org/pulp_python/docs/admin/reference/settings/) | ||
| * [Rest API](https://pulpproject.org/pulp_python/restapi/) | ||
| * [Changelog](https://pulpproject.org/pulp_python/changes/) |
There was a problem hiding this comment.
This hardcoded ToC is not required. It will be generated on build-time
There was a problem hiding this comment.
And appended to this file (when its working)
staging_docs/user/guides/sync.md
Outdated
| modifying the "policy" field. | ||
|
|
||
| Syncing all of PyPI can take a long time depending on your network and disk speeds. Check out | ||
| [pull-through caching](publish.md#enable-pull-through-caching) |
There was a problem hiding this comment.
I think this won't work, Mike had a similar problem last week.
My theory is that some config makes the path be relative to the html structure (guides/sync/index.html, rather than the actual guides dir). So ../publish.md would probably work ,but its weird. Or you can use the absolute links, which the recommended way.
|
@gerrod3 , I've fixed the index page issue. |
There was a problem hiding this comment.
This page still has the production urls for internal links, use the [](site:{path}) here too
[noissue]
| # Build custom package | ||
| python -m build $PLUGIN_SOURCE | ||
| # Upload built package distributions to my-pypi | ||
| twine upload --repository-url $BASE_ADDR/pypi/my-pypi/simple/ -u admin -p password "$PLUGIN_SOURCE"dist/* |
There was a problem hiding this comment.
We should probably have our example use API token auth, I don't recall if they've shut down username/password auth entirely yet but I remember reading that they were going to.
There was a problem hiding this comment.
We will need to add support then, currently we don't.
There was a problem hiding this comment.
Ah, right, this is uploading into a Pulp repository.
Yeah.
|
|
||
| Creating a remote object informs Pulp about an external content source. In this case, we will be | ||
| using a fixture, but Python remotes can be anything that implements the PyPI API. This can be PyPI | ||
| itself, a fixture, or even an instance of Pulp 2. |
There was a problem hiding this comment.
At this point we should remove Pulp 2 references
@pedro-psb How do I get the guides to be in order, without the numbers in the name?