Project

Profile

Help

Task #7229

publish plugin documentation at docs.pulpproject.org

Added by dkliban@redhat.com 15 days ago. Updated 8 days ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Sprint:

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.

History

#1 Updated by bmbouter 15 days ago

  • Description updated (diff)

Renamed "project" to plugin for clarity.

#2 Updated by dkliban@redhat.com 15 days ago

  • Description updated (diff)

#3 Updated by dkliban@redhat.com 15 days ago

  • Description updated (diff)

#4 Updated by duck 8 days ago

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.

#5 Updated by duck 8 days ago

I am not allowed to change the status of this issue to reflect it's now WIP, could someone do that please?

Please register to edit this issue

Also available in: Atom PDF