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

RM: Remove the reference for the license strings #732

Merged
merged 1 commit into from
Jul 31, 2024

Conversation

angolini
Copy link
Collaborator

The license string used on the recipes is an information which constantly changing, so having it static in the documentation can lead the reader to error.

Adding the link where to find the most current regex can help.

PR Template and Checklist

This text can lead to an error if it's not up to date (and this has changed more than once in last 2 years). So, let's remove it and add the link instead.

While on this, fix some grammar points.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

The license string used on the recipes is an information which
constantly changing, so having it static in the documentation can lead
the reader to error.

Adding the link where to find the most current regex can help.

Signed-off-by: Daiane Angolini <[email protected]>
@angolini
Copy link
Collaborator Author

Locally, I've faced this build error:

Warning, treated as error:
/home/daiane/foundries/docs/source/glossary/index.rst:355:term layer not found in case sensitive match.made a reference to Layer instead.
make: *** [Makefile:33: html] Error 2

Let's see if the same happens in the CI

@angolini angolini requested review from kprosise and a team July 30, 2024 18:19
@doanac
Copy link
Member

doanac commented Jul 30, 2024

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

LGTM, will merge whenever you're ready for me to do so!

@kprosise
Copy link
Contributor

Locally, I've faced this build error:

Warning, treated as error:
/home/daiane/foundries/docs/source/glossary/index.rst:355:term layer not found in case sensitive match.made a reference to Layer instead.
make: *** [Makefile:33: html] Error 2

Let's see if the same happens in the CI

Odd that it is being reported as an error, should be a warning, at best...additionally that is the expected/desired behavior (falling back to case insensitive if no case match). I can look into why it is being treated as error.

@kprosise kprosise merged commit c248c3b into foundriesio:main Jul 31, 2024
1 of 3 checks passed
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

Successfully merging this pull request may close these issues.

3 participants