Project

Profile

Help

Task #7229

publish plugin documentation at docs.pulpproject.org

Added by dkliban@redhat.com 3 months ago. Updated about 1 month ago.

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

0%

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

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.


Related issues

Has duplicate Pulp - Task #5542: Have Travis publish our plugin docsCLOSED - DUPLICATE

<a title="Actions" class="icon-only icon-actions js-contextmenu" href="#">Actions</a>

Associated revisions

Revision c775bd5f View on GitHub
Added by dkliban@redhat.com 2 months ago

Changes docs publishing to docs.pulpproject.org/pulpcore/

re: #7229 https://pulp.plan.io/issues/7229

Revision 01d82ed7 View on GitHub
Added by dkliban@redhat.com about 2 months ago

Changes the username and rsync path for doc publishing

re: #7229 https://pulp.plan.io/issues/7229

Revision 521dbcdb View on GitHub
Added by dkliban@redhat.com about 2 months ago

Updates the location of where docs are published on pulpproject.org

re: #7229 https://pulp.plan.io/issues/7229

Revision dc9e98c5 View on GitHub
Added by dkliban@redhat.com about 2 months ago

Changes docs publishing to docs.pulpproject.org/pulpcore/

re: #7229 https://pulp.plan.io/issues/7229

Revision 4080241e View on GitHub
Added by dkliban@redhat.com about 2 months ago

Changes the username and rsync path for doc publishing

re: #7229 https://pulp.plan.io/issues/7229

Revision cb29910b View on GitHub
Added by dkliban@redhat.com about 2 months ago

Updates the location of where docs are published on pulpproject.org

re: #7229 https://pulp.plan.io/issues/7229

Revision c4a3443e View on GitHub
Added by dkliban@redhat.com about 1 month ago

Adds support for publishing docs to pulpproject.org

re: #7229 https://pulp.plan.io/issues/7229

History

#1 Updated by bmbouter 3 months ago

  • Description updated (diff)

Renamed "project" to plugin for clarity.

#2 Updated by dkliban@redhat.com 3 months ago

  • Description updated (diff)

#3 Updated by dkliban@redhat.com 3 months ago

  • Description updated (diff)

#4 Updated by duck 3 months 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 3 months ago

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

#6 Updated by dkliban@redhat.com 2 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to duck

#7 Updated by duck 2 months ago

I updated the PR with all the keys and fixed E208 spotted by ansible-lint.

#8 Updated by pulpbot 2 months ago

  • Status changed from ASSIGNED to POST

#12 Updated by duck about 2 months ago

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.

#13 Updated by dkliban@redhat.com about 2 months ago

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.

#14 Updated by duck about 2 months ago

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.

#18 Updated by dkliban@redhat.com about 2 months ago

  • 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.

#19 Updated by dkliban@redhat.com about 2 months ago

  • Sprint/Milestone set to 3.6.1

#20 Updated by pulpbot about 2 months ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

#21 Updated by dkliban@redhat.com about 1 month ago

  • 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.

#22 Updated by daviddavis 26 days ago

  • Has duplicate Task #5542: Have Travis publish our plugin docs added

Please register to edit this issue

Also available in: Atom PDF