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

flatten changelog into current release and release history for ease of maintenance #7887

Merged
merged 4 commits into from
May 23, 2024

Conversation

jodygarnett
Copy link
Contributor

@jodygarnett jodygarnett commented Mar 20, 2024

This pull request addresses concerns raised in #7886

This is blocked by:

To address we will need to coordinate an update across documentation branches:

Changes

A banner will be displayed when 4.4 passes into maintenance.

With this change the navigate and changelog match up:

image

Release History is one page that is hopefully easier to maintain:

image

Checklist

  • I have read the contribution guidelines
  • Pull request provided for main branch, backports managed with label
  • Good housekeeping of code, cleaning up comments, tests, and documentation
  • Clean commit history broken into understandable chucks, avoiding big commits with hundreds of files, cautious of reformatting and whitespace changes
  • Clean commit messages, longer verbose messages are encouraged
  • API Changes are identified in commit messages
  • Testing provided for features or enhancements using automatic tests
  • User documentation provided for new features or enhancements in manual
  • Build documentation provided for development instructions in README.md files
  • Library management using pom.xml dependency management. Update build documentation with intended library use and library tutorials or documentation

@jodygarnett
Copy link
Contributor Author

This change has gone stale, need to work on moving these kind of changes faster

@jodygarnett jodygarnett added the stale stale issue flagged for closure. label Apr 18, 2024
@juanluisrp
Copy link
Contributor

@jodygarnett I've rebased main and fixed the conflicts. I've added a entry in the navigation tree for 4.2.9 version under changelog and a link in the entry in the change-log/index.md to keep an easy access to the latest version of that branch. I've also added 4.4.4 to the history list.

image
image

Copy link
Contributor

@juanluisrp juanluisrp left a comment

Choose a reason for hiding this comment

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

LGTM.

@josegar74
Copy link
Member

@jodygarnett with mkdocs serve I get the following, with the 2 entries None:

mkdocs-serve

With mike serve I get the old format. I guess this doesn't take the local changes?

mike-serve

@jodygarnett
Copy link
Contributor Author

i do not know what is up with the None entries? did you do a clean?

@josegar74
Copy link
Member

i do not know what is up with the None entries? did you do a clean?

@jodygarnett it is related to the version of mike. I had 1.5.3, but upgrading to 1.6.0 works fine.

@josegar74 josegar74 merged commit 7caa17e into geonetwork:main May 23, 2024
7 checks passed
@josegar74 josegar74 removed the stale stale issue flagged for closure. label May 23, 2024
@jodygarnett
Copy link
Contributor Author

lol - I just figured that out also, adding instructions on how to update to the readme. Also removing the docker instructions (as we have have some non standard plugins now that are not included with default mkdocs docker image).

jodygarnett added a commit to jodygarnett/core-geonetwork that referenced this pull request May 24, 2024
…f maintenance (geonetwork#7887)

* flatten changelog into current release and release history for ease of maintenance

* Deploy instructons with banner when viewing non stable docs

* fixup! Deploy instructons with banner when viewing non stable docs

* fixup! fixup! Deploy instructons with banner when viewing non stable docs

---------

Co-authored-by: Juan Luis Rodríguez <[email protected]>
# Conflicts:
#	docs/manual/docs/maintainer-guide/updating/index.md
#	docs/manual/docs/overview/change-log/history/index.md
#	docs/manual/docs/overview/change-log/index.md
#	docs/manual/docs/overview/change-log/maintenance/index.md
#	docs/manual/mkdocs.yml
jodygarnett added a commit to jodygarnett/core-geonetwork that referenced this pull request May 24, 2024
…f maintenance (geonetwork#7887)

* flatten changelog into current release and release history for ease of maintenance

* Deploy instructons with banner when viewing non stable docs

* fixup! Deploy instructons with banner when viewing non stable docs

* fixup! fixup! Deploy instructons with banner when viewing non stable docs

---------

Co-authored-by: Juan Luis Rodríguez <[email protected]>
# Conflicts:
#	docs/manual/docs/maintainer-guide/updating/index.md
#	docs/manual/docs/overview/change-log/history/index.md
#	docs/manual/docs/overview/change-log/index.md
#	docs/manual/docs/overview/change-log/maintenance/index.md
#	docs/manual/mkdocs.yml

# Conflicts:
#	docs/manual/docs/maintainer-guide/updating/index.md
#	docs/manual/docs/overview/change-log/history/index.md
#	docs/manual/docs/overview/change-log/index.md
#	docs/manual/mkdocs.yml
jodygarnett added a commit that referenced this pull request May 27, 2024
…istory for ease of maintenance (#8093)

* flatten changelog into current release and release history for ease of maintenance (#7887)
* flatten changelog into current release and release history for ease of maintenance
* Deploy instructons with banner when viewing non stable docs
* fixup! Deploy instructons with banner when viewing non stable docs
* fixup! fixup! Deploy instructons with banner when viewing non stable docs

---------

Co-authored-by: Juan Luis Rodríguez <[email protected]>
# Conflicts:
#	docs/manual/docs/maintainer-guide/updating/index.md
#	docs/manual/docs/overview/change-log/history/index.md
#	docs/manual/docs/overview/change-log/index.md
#	docs/manual/docs/overview/change-log/maintenance/index.md
#	docs/manual/mkdocs.yml

* how to update mkdoc env (removed instructions for docker mkdocs use)

* maintenance release description, fix broken link on change-log/history for stable and maintenance headings

# Conflicts:
#	docs/manual/docs/overview/change-log/history/index.md

* fix documentation warnings

* reduce instructions to what is useful for the 4.2 branch

* outdated banner
jodygarnett added a commit that referenced this pull request May 27, 2024
…history for ease of maintenance (#8094)

* flatten changelog into current release and release history for ease of maintenance (#7887)
* flatten changelog into current release and release history for ease of maintenance
* Deploy instructons with banner when viewing non stable docs
* fixup! Deploy instructons with banner when viewing non stable docs
* fixup! fixup! Deploy instructons with banner when viewing non stable docs

---------

Co-authored-by: Juan Luis Rodríguez <[email protected]>
# Conflicts:
#	docs/manual/docs/maintainer-guide/updating/index.md
#	docs/manual/docs/overview/change-log/history/index.md
#	docs/manual/docs/overview/change-log/index.md
#	docs/manual/docs/overview/change-log/maintenance/index.md
#	docs/manual/mkdocs.yml

# Conflicts:
#	docs/manual/docs/maintainer-guide/updating/index.md
#	docs/manual/docs/overview/change-log/history/index.md
#	docs/manual/docs/overview/change-log/index.md
#	docs/manual/mkdocs.yml

* how to update mkdoc env (removed instructions for docker mkdocs use)

# Conflicts:
#	docs/manual/README.md

* reduce instructions to what is useful for the 3.12 branch

* outdated banner

* fix documentation warnings
fxprunayre pushed a commit to SPW-DIG/metawal-core-geonetwork that referenced this pull request Jul 18, 2024
…f maintenance (geonetwork#7887)

* flatten changelog into current release and release history for ease of maintenance

* Deploy instructons with banner when viewing non stable docs

* fixup! Deploy instructons with banner when viewing non stable docs

* fixup! fixup! Deploy instructons with banner when viewing non stable docs

---------

Co-authored-by: Juan Luis Rodríguez <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation writing & improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants