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

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

Merged
merged 4 commits into from
May 27, 2024

Conversation

jodygarnett
Copy link
Contributor

In response to #7887 testing on outdated version.

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

jodygarnett commented May 24, 2024

@jodygarnett
Copy link
Contributor Author

The failure gn-camelPeriodicProducer is not related to this documentation change.

@jodygarnett jodygarnett merged commit 76eaa71 into geonetwork:main May 27, 2024
6 of 7 checks passed
@geonetworkbuild
Copy link
Collaborator

The backport to 4.2.x failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply 4a2b9e8ea8... maintenance release description, fix broken link on change-log/history for stable and maintenance headings
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
hint: Disable this message with "git config advice.mergeConflict false"

stdout
Auto-merging docs/manual/README.md
[backport-8089-to-4.2.x bb8d0e176a] how to update mkdoc env (removed instructions for docker mkdocs use)
 Author: Jody Garnett <[email protected]>
 Date: Thu May 23 11:14:38 2024 -0700
 1 file changed, 20 insertions(+), 9 deletions(-)
Auto-merging docs/manual/README.md
CONFLICT (content): Merge conflict in docs/manual/README.md
Auto-merging docs/manual/docs/overview/change-log/archive/index.md
CONFLICT (content): Merge conflict in docs/manual/docs/overview/change-log/archive/index.md

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-4.2.x 4.2.x
# Navigate to the new working tree
cd .worktrees/backport-4.2.x
# Create a new branch
git switch --create backport-8089-to-4.2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick 44cbf6c4aff8e5cd4cfc53023415c2d5c716aaba,4a2b9e8ea857fd6d098f563f31f35ccb425abf8b,05bd952a8e80117954fac242a322ffabf407126c,9402d4cdd70b93c4fc9209a8b1d9246bef73622b
# Push it to GitHub
git push --set-upstream origin backport-8089-to-4.2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-4.2.x

Then, create a pull request where the base branch is 4.2.x and the compare/head branch is backport-8089-to-4.2.x.

@jodygarnett
Copy link
Contributor Author

I updated the header to indicate 4.4 is latest (not stable) - it was appearing as outdated; we will need to remember to update this when 4.4 becomes outdated in the future years.

Also the version selector now working, used new mike alias: true setting to simplify deployment.

fxprunayre pushed a commit to SPW-DIG/metawal-core-geonetwork that referenced this pull request Jul 18, 2024
…eonetwork#8089)

* 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
* added outdated banner for when 4.4.x eventually is unsupported
* fix documentation warnings
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.

3 participants