Skip to content
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

Remove the outdated information from the docs #5889

Merged
merged 1 commit into from
Oct 9, 2024

Conversation

lubosmj
Copy link
Member

@lubosmj lubosmj commented Oct 9, 2024

No description provided.

@lubosmj
Copy link
Member Author

lubosmj commented Oct 9, 2024

Inspired by https://github.com/pulp/pulp-cli/blob/main/releasing.md (which is easy to find and follow).

@lubosmj lubosmj force-pushed the revise-docs-again branch 2 times, most recently from c2f7a5a to 1625b71 Compare October 9, 2024 10:13
Copy link
Member

@mdellweg mdellweg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a fan of keeping the information with the code. In this case, I guess the "release.md" should come with the template.

MANIFEST.in Outdated
@@ -15,3 +15,4 @@ include COPYRIGHT
include pulpcore/app/templates/rest_framework/api.html
include manage.py
include test_requirements.txt
include RELEASING.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, let's ignore and not include this file in the published artifacts.

RELEASING.md Outdated
```

### Create a New Y-branch of Pulpcore (e.g., 3.23)
- If needed, trigger a [Create New Release Branch](https://github.com/pulp/pulpcore/actions/workflows/create-branch.yml) job via the GitHub Actions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This creates the bump version PR. That one needs to be watched and prioritised.

Comment on lines -538 to -539

ACS support is provided as a tech preview in pulp_file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes warrant for at least a separate commit.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found these to be a leftover after merging pulp-file into pulpcore.

@lubosmj lubosmj force-pushed the revise-docs-again branch 2 times, most recently from 3ee7d06 to 19661e5 Compare October 9, 2024 10:20
@lubosmj
Copy link
Member Author

lubosmj commented Oct 9, 2024

I'm a fan of keeping the information with the code. In this case, I guess the "release.md" should come with the template.

Good idea. However, how can we ensure that this file is shipped together with the plugin-template plugin --github update? It will come from the root directory of the plugin's template.

@mdellweg
Copy link
Member

mdellweg commented Oct 9, 2024

I think it should go in the templated section. The plugin template repo does not want to have a "How to release" document for itself.

@lubosmj lubosmj changed the title Revise the docs and update the releasing workflow Remove the outdated information from the docs Oct 9, 2024
@lubosmj
Copy link
Member Author

lubosmj commented Oct 9, 2024

The initial change should be now shipped through the plugin template, please review: pulp/plugin_template#919.

I still think the proposed removals should be merged.

@lubosmj lubosmj merged commit a5b07f5 into pulp:main Oct 9, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants