-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cleaning up docs-related stuff #901
Comments
That all sounds good to me. |
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
pedro-psb
added a commit
to pedro-psb/plugin_template
that referenced
this issue
Jul 26, 2024
This does: * Adds a docs test workflow in the ci.yml * Removes docs test from test.yml workflow (which tests the plugin) * Deprecate --docs feature from plugin-template * remove docs_test option * remove template/docs * remove template/bootstrap/docs legacy content * remove ci_update_docs * make it no-ops * Update various info across files Closes: pulp#901
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The new process of building docs is quite different from the one we had before, and there are some things that doesnt make sense to be kept in the plugin-template machinery anymore:
ci_update_docs
On a rough perspective, this option was useful before because each plugin docs was more independent.
Now the control of the docs process is centralized in the pulp-docs tool, plus we don't worry about building docs for older branches anymore. AFAIK, all the old machinery is already deactivated and I can't think of a reason to keep it.
If that sounds good, we should:
template/docs
--docs
and make it no-opsdocs_test
Similarly, this made sense with independent docs, but that's unsafe in the current centralized approach.
If one repo decides to disable docs testing, all plugin CI are in the risk of failing if this one plugin merges something that will break the unified docs build.
This is to say that, if a plugin is part of the unified docs, it must test the docs.
Alternative for not testing docs
If the plugin doesnt want to be part of the unified-docs, it can "unsubcribe" via a PR to remove itself from the participants list.
Currently, the docs-participant list lives in pulp-docs (here).
This handling of the subscription can be improved, but it would already work as it is.
An improvement idea I had is to keep such a list of participants here in plugin_template, so its more convenient to match with docs testing workflows: a plugin will only have docs workflow if it's in the list, and pulp-docs will only use that plugin if it's in that list. It wouldn't be a problem for pulp-docs to have to fetch that list from here, as its by nature an aggregation tool.
The text was updated successfully, but these errors were encountered: