Task #7229
closed
publish plugin documentation at docs.pulpproject.org
Status:
CLOSED - WORKSFORME
Description
We currently host 'pulpcore' documentation at the root of docs.pulproject.org. We want to publish documentation for additional pulp plugins under that domain. We want each plugin to be stored in the directory corresponding to its name.
docs.pulpproject.org/pulpcore/
docs.pulpproject.org/pulp_rpm/
docs.pulpproject.org/pulp_file/
docs.pulpproject.org/pulp_container/
docs.pulpproject.org/pulp_deb/
docs.pulpproject.org/pulp_gem/
docs.pulpproject.org/pulp_npm/
docs.pulpproject.org/pulp_maven/
docs.pulpproject.org/pulp_python/
docs.pulpproject.org/pulp_ansible/
The root of the domain should forward users to docs.pulpproject.org/pulpcore/.
Each plugin should use its own user (named the same as the directory). Each user should only have the ability to write to its plugin directory. Each plugin is going to use rsync (and a unique private key) to publish the documentation to its directory.
- Description updated (diff)
Renamed "project" to plugin for clarity.
- Description updated (diff)
- Description updated (diff)
Here is a proposal: https://github.com/pulp/pulp-infra-ansible/pull/9
Please provide all the component<->SSH key associations so I can fill-in the Ansible rules with it.
The redirection is currently commented-out until the core is synced properly. Beware the username is going to change.
Once all the components sync properly I'll remove the old user and cleanup the vhost's top directory.
Tell me what you think about it.
I am not allowed to change the status of this issue to reflect it's now WIP, could someone do that please?
- Status changed from NEW to ASSIGNED
- Assignee set to duck
I updated the PR with all the keys and fixed E208 spotted by ansible-lint.
- Status changed from ASSIGNED to POST
The core is published and old URLs are redirected.
Components are not yet synced, let's check this too.
I's like to cleanup the old sync account, may I remove it now? As for the files in the root directory of the vhost, using the same exceptions as the redirection, I guess I can remove everything?
Also while looking at it I realized there is a _sources subdirectory;. If the goal of this link is to encourage people to contribute I would suggest linking to GH instead of embedding the sources.
duck wrote:
The core is published and old URLs are redirected.
Components are not yet synced, let's check this too.
I's like to cleanup the old sync account, may I remove it now? As for the files in the root directory of the vhost, using the same exceptions as the redirection, I guess I can remove everything?
You can remove the old doc_builder account. We are no longer using it.
You can remove everything from the root of docs.pulpproject.org vhost using the same exceptions as redirection.
Also while looking at it I realized there is a _sources subdirectory;. If the goal of this link is to encourage people to contribute I would suggest linking to GH instead of embedding the sources.
This gets generated when we build our docs. We don't ever point users to these files. We always tell users to submit docs changes via github.
I did the cleanup.
As for _sources, your doc builder, or the template used, creates a View page source link top-right on all pages.
- Status changed from POST to MODIFIED
I am setting this issue to MODIFIED because the pulpcore docs will now be published to the new location. If we find any issues with plugins, I will open a new ticket.
- Sprint/Milestone set to 3.6.1
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
- Status changed from CLOSED - CURRENTRELEASE to POST
- Sprint/Milestone deleted (
3.6.1)
Setting back to POST just so I can merge the changes to plugin_template repo.
- Has duplicate Task #5542: Have Travis publish our plugin docs added
- Status changed from POST to CLOSED - WORKSFORME
Also available in: Atom
PDF
.
Changes docs publishing to docs.pulpproject.org/pulpcore/
re: #7229 https://pulp.plan.io/issues/7229