Skip to content

[DOC] date_range: Update broken image links #841

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

Merged
merged 1 commit into from
Mar 14, 2024
Merged

Conversation

amh-mw
Copy link

@amh-mw amh-mw commented Mar 12, 2024

No description provided.

@OCA-git-bot
Copy link
Contributor

Hi @lmignon,
some modules you are maintaining are being modified, check this out!

@amh-mw amh-mw changed the title [DOC] Update broken image links in README.rst [DOC] date_range: Update broken image links in README.rst Mar 12, 2024
Copy link
Contributor

@lmignon lmignon left a comment

Choose a reason for hiding this comment

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

Hi @amh-mw

Thank you for your contrib. The README.rst file is generated from fragments defined into several files located under the readme directory. The right fix is to modify the links into these files. Once done, the README.rst will be generated at merge time. Can you update your PR accordingly?

@amh-mw amh-mw changed the title [DOC] date_range: Update broken image links in README.rst [DOC] date_range: Update broken image links Mar 12, 2024
@francesco-ooops
Copy link
Contributor

@francesco-ooops
Copy link
Contributor

@lmignon I think it's better to use relative paths

@@ -12,7 +12,7 @@ inherit from `date.range.search.mixin`:

This will make a `Period` field show up in the search view:

.. figure:: https://raw.githubusercontent.com/OCA/server-tools/12.0/date_range/static/description/date_range_many2one_search_field.png
.. figure:: https://raw.githubusercontent.com/OCA/server-ux/15.0/date_range/static/description/date_range_many2one_search_field.png
Copy link
Member

Choose a reason for hiding this comment

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

The correct way to put it and forget about this on each version is to put a relative path, and let the README generator to put the absolute one, but meanwhile, you see the correct image in local devel env.

Suggested change
.. figure:: https://raw.githubusercontent.com/OCA/server-ux/15.0/date_range/static/description/date_range_many2one_search_field.png
.. figure:: ../static/description/date_range_many2one_search_field.png

Copy link
Contributor

Choose a reason for hiding this comment

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

@pedrobaeza you're right. I just checked the readme generator and relative paths are replaced by the right absolute path at generation.

Copy link
Contributor

@lmignon lmignon left a comment

Choose a reason for hiding this comment

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

As stated by others reviewers, the path must be relative

Copy link
Contributor

@francesco-ooops francesco-ooops left a comment

Choose a reason for hiding this comment

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

LGTM

@amh-mw would you be so kind to open a PR for v16 as well? Thanks!

@pedrobaeza pedrobaeza added this to the 15.0 milestone Mar 14, 2024
@lmignon
Copy link
Contributor

lmignon commented Mar 14, 2024

/ocabot merge nobump

@OCA-git-bot
Copy link
Contributor

Hey, thanks for contributing! Proceeding to merge this for you.
Prepared branch 15.0-ocabot-merge-pr-841-by-lmignon-bump-nobump, awaiting test results.

@OCA-git-bot OCA-git-bot merged commit 2f542db into OCA:15.0 Mar 14, 2024
@OCA-git-bot
Copy link
Contributor

Congratulations, your PR was merged at 3f73626. Thanks a lot for contributing to OCA. ❤️

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.

5 participants