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

update docs change log for moin2 beta release #1616

Open
RogerHaase opened this issue Feb 22, 2024 · 5 comments
Open

update docs change log for moin2 beta release #1616

RogerHaase opened this issue Feb 22, 2024 · 5 comments
Assignees
Milestone

Comments

@RogerHaase
Copy link
Member

url: https://moin-20.readthedocs.io/en/latest/admin/changes.html

Current files:

  • docs/admin/changes.rst
  • docs/changes/CHANGES
  • plus 2 SoC files in docs/changes/*

TODO:

  • ignore 2 SoC files for now
  • add mini description of Fixes, Features, Other changes
  • add more detail for beta
  • the moin1.x changelog can be easily copied over, but do it later (if wanted)

suggestions?

@RogerHaase RogerHaase added this to the 2.0.0a1 milestone Feb 22, 2024
@RogerHaase RogerHaase self-assigned this Feb 22, 2024
RogerHaase added a commit to RogerHaase/moin that referenced this issue Feb 22, 2024
RogerHaase added a commit that referenced this issue Feb 22, 2024
update docs change log for moin2 alpha release #1616
@UlrichB22
Copy link
Collaborator

I think we can remove the 2 SoC documents, they are just about adding support for markup languages: html, restructured text, docbook, mediawiki and moinwiki.

As mentioned in #941 (comment) we should just start with an initial empty change document. For the next releases we need to document major changes and bugfixes.

@UlrichB22
Copy link
Collaborator

We can use automatically generated release notes generated from pull requests in the future:

https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

PRs can be tagged to be included or excluded. Structuring with tagging for bug fixes and new features is also possible.

@ThomasWaldmann
Copy link
Member

ThomasWaldmann commented Feb 24, 2024

I suspect that automatically generated release notes are nowhere nearly good content as manually created ones. This is especially true if commit comments tend to be a bit sloppy.

For my other projects I usually do "update CHANGES" manual commits now and then, based on the output of git log COMMITHASH.. (COMMITHASH being the previous merge of the manual "update CHANGES" PR), which I edit and rearrange manually into fixes, new features and other changes.

RogerHaase added a commit to RogerHaase/moin that referenced this issue Feb 24, 2024
RogerHaase added a commit that referenced this issue Feb 25, 2024
update CHANGES for alpha release, remove SoC files #1616
@ThomasWaldmann
Copy link
Member

This is the last issue in the still open 2.0.0a1 milestone.

Is it done, close?

Close the milestone?

@RogerHaase ^^

@RogerHaase RogerHaase changed the title update docs change log for moin2 alpha release update docs change log for moin2 beta release Apr 3, 2024
@RogerHaase RogerHaase modified the milestones: 2.0.0a1, 2.0.0b1 Apr 3, 2024
@RogerHaase
Copy link
Member Author

I was lazy and changed the title and milestone with the intent of doing a better job on the changelog for a1 and b1.

I closed the a1 milestone just now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants