[Pulp-dev] moving plugin docs to docs.pulpproject.org

Dennis Kliban dkliban at redhat.com
Fri Dec 11 17:41:23 UTC 2020


The docs are published as part of the release workflow and also as a cron
job. The cron job publishes to
docs.pulpproject.org/<plugin_snake>/<branch_name>/nightly/.
e.g.: https://docs.pulpproject.org/pulpcore/en/master/nightly/

On Fri, Dec 11, 2020 at 4:13 AM Tanya Tereshchenko <ttereshc at redhat.com>
wrote:

> Thanks!
>
> How do I trigger the docs job?
> Is it a part of the release workflow only or is there a way for me to
> publish docs before a release?
>
> Tanya
>
> On Thu, Dec 10, 2020 at 8:45 PM Dennis Kliban <dkliban at redhat.com> wrote:
>
>> Each plugin repository in the Pulp organization on GitHub has been
>> configured with a PULP_DOCS_KEY secret that enables publishing docs to
>> docs.pulpproject.org/.
>>
>> Each plugin should enable publishing docs to docs.pulpproject.org by
>> setting 'publish_docs_to_pulpprojectdotorg' to true in the
>> template_config.yaml and re-running the 'plugin-template --github' command.
>>
>> Once your plugin has been configured to publish to docs.pulpproject.org,
>> please update the README for the git repository as well as
>> pulpproject.org with the new links for documentation[0]. After this, the
>> readthedocs.org site should be disabled.
>>
>> [0] https://pulpproject.org/content-plugins/
>> _______________________________________________
>> Pulp-dev mailing list
>> Pulp-dev at redhat.com
>> https://www.redhat.com/mailman/listinfo/pulp-dev
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20201211/db407e2c/attachment.htm>


More information about the Pulp-dev mailing list