The guide publishes to the wrong place (/<project-name>)

Bug #1720011 reported by Alex Kavanagh
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Charms Deployment Guide
Fix Released
High
Alex Kavanagh

Bug Description

So the guide publishes to /charm-deployment-guide which is the wrong place. It should deploy to /project-deploy-guides/charm-deployment-guide/...

However, it was proving very difficult to track down what the issue is/was. The issue is that the OpenStack infrastructure provides for every openstack project to have a /docs directory which gets published to the /<project-name>. This is how the charm-deployment-guide project is set up, and so the deployment guide LOOKS like the docs for the project called 'charm-deployment-guide'.

Deployment guide documentation publishing has been added on later. Thus, for the charm-deployment-guide project, it doesn't want 'docs' nor a gate that publishes project documentation; instead it needs to publish deployment documentation.

Some useful backgrounder/comparison information is:

<beisner> tinwood jamespage - at a glance, i think we need to modify project-config for charm-deployment-guide to include a deploy-guide-jobs key: https://github.com/openstack-infra/project-config/blob/bdf397a3fa3091c71dba69e08ecae2bc9d55dadf/jenkins/jobs/projects.yaml#L13332

(in full):
- project:
    name: tripleo-docs

    jobs:
      - gate-{name}-docs-{node}:
          node: ubuntu-xenial
      - openstack-publish-jobs
      - deploy-guide-jobs:
          service: tripleo

Notice that, although there is a gate-{name}-docs-{node} job, the one that publishes the deployment guide is the 'deploy-guide-jobs'. The significance of 'service: tripleo' is not understood at present.

1. The project-config for the charm-deployment-guide project needs to be change to just do a deploy-guide job.
2. The charm-deployment-guide project needs to move /docs to /deploy and remove the [sphinx-build] directive in the setup.cfg as it's no longer needed.

James Page (james-page)
Changed in charm-deployment-guide:
status: New → Triaged
importance: Undecided → High
Changed in charm-deployment-guide:
assignee: nobody → Alex Kavanagh (ajkavanagh)
status: Triaged → In Progress
Revision history for this message
Alex Kavanagh (ajkavanagh) wrote :

Confirmed as sorted out:

Juju charms deploy guide is referenced at https://docs.openstack.org/rocky/deploy/
Deployment guide is at: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/rocky/

All is good.

Changed in charm-deployment-guide:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.