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

docs: fix image links in change-log(version-3.8.0.md and 4.0.0-alpha.1 #7938

Merged
merged 3 commits into from
Jun 19, 2024

Conversation

bernhardreiter
Copy link
Contributor

  • remove use of HTML blocks instead of Markdown's image syntax to be
    more consistent and help mike and mkdocs to get relative links right.

resolve #7847

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

* Use Markdowns image syntax instead of the HTML block `figure` to be consistent (and to improve mkdocs mike generation)
* Use Markdowns image syntax instead of the HTML block `figure` to be consistent (and to improve mkdocs mike generation)
Copy link
Contributor

@jodygarnett jodygarnett left a comment

Choose a reason for hiding this comment

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

Added suggestions to follow writing guidelines on figures:

https://docs.geonetwork-opensource.org/4.2/devel/docs/markdown/#icons-images-and-figures

docs/manual/docs/overview/change-log/version-3.8.0.md Outdated Show resolved Hide resolved
Update figures to follow geonetwork docs writing guidelines (makes use of CSS to be similar to display of html figure)
Copy link
Contributor

@jodygarnett jodygarnett left a comment

Choose a reason for hiding this comment

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

Suggestions applied, this should be good to go.

@fxprunayre fxprunayre merged commit 6b95d5c into geonetwork:main Jun 19, 2024
8 checks passed
fxprunayre pushed a commit to SPW-DIG/metawal-core-geonetwork that referenced this pull request Jul 18, 2024
geonetwork#7938)

* docs: fix images in changelog/version-3.8.0.md

* Use Markdowns image syntax instead of the HTML block `figure` to be consistent (and to improve mkdocs mike generation)

* docs: improve images in change-log/version-4.0.0-alpha.1.md

* Use Markdowns image syntax instead of the HTML block `figure` to be consistent (and to improve mkdocs mike generation)

* Apply suggestions from code review

Update figures to follow geonetwork docs writing guidelines (makes use of CSS to be similar to display of html figure)

---------

Co-authored-by: Jody Garnett <[email protected]>
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.

Docs: image links for the online docs in section archive broken
3 participants