[OpenStack-Infra] Multi-Source Publishing on docs.airshipit.org

Andreas Jaeger aj at suse.com
Mon Apr 20 16:29:02 UTC 2020


On 20.04.20 16:37, WALTERS, ANDREW wrote:
> Hello!
> 
>  
> 
> Thank you for giving Airship documentation a home. Having our
> documentation spread across several Read the Docs sites has long been a
> frustration for new Airship users. We are excited to fully embrace the
> site but cannot do so until all of our content is represented there.
> Since we have many source code repositories, our documentation
> originates from several different locations. For example, Treasuremap is
> publishing to docs.airshipit.org; however, Armada documentation [0] is
> not reachable from that page
> 
>  
> 
> The Airship Working Committee has considered how to accomplish hosting
> all of our documentation on the same site while allowing it to live in
> the same repositories as the corresponding source code. Looking at the
> publish job [1], it appears that we could accomplish this by removing
> the final key, adding all of our projects to the “allowed-projects”
> list, and overriding the “publish_site” variable in repository-specific
> jobs. For example, we could create a job in the Armada repository that

No, you're not allowed to override the variable. Instead change it to
have a variable in it like:
publish_site: "airshipit.org/docs/{{ zuul.project.short_name }}"


So, create a new job with the changed variable and use that new job
everywhere,

Andreas

> publishes to “airshipit.org/docs/armada” and link to it from our main
> documentation at docs.airshipit.org.
> 
>  
> 
> Is our approach feasible given our current setup? If so, the Working
> Committee will start submitting the necessary changes.
> 
>  
> 
> Thanks in advance for your help!
> 
>  
> 
> Best regards,
> 
>  
> 
> Drew Walters
> 
> Airship Working Committee
> 
>  
> 
> [0] https://airshipit.readthedocs.io/projects/armada/en/latest/
> 
> [1]
> https://opendev.org/openstack/project-config/src/branch/master/zuul.d/jobs.yaml#L452
> 
> 
> _______________________________________________
> OpenStack-Infra mailing list
> OpenStack-Infra at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-infra
> 


-- 
 Andreas Jaeger aj at suse.com Twitter: jaegerandi
  SUSE Software Solutions Germany GmbH, Maxfeldstr. 5, D 90409 Nürnberg
   (HRB 36809, AG Nürnberg) GF: Felix Imendörffer
    GPG fingerprint = EF18 1673 38C4 A372 86B1  E699 5294 24A3 FF91 2ACB



More information about the OpenStack-Infra mailing list