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

Fix links redirecting to powsybl website documentation #822

Merged
merged 3 commits into from
Sep 16, 2024

Conversation

colinepiloquet
Copy link
Member

@colinepiloquet colinepiloquet commented Sep 4, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines

Does this PR already have an issue describing the problem?

No

What kind of change does this PR introduce?

Docs update

What is the current behavior?

Some links refer to powysbl.org documentation that has been deleted.

What is the new behavior (if this is a feature change)?
Replaced by readthedocs website. However, I didn't manage to use Intersphinx...

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

Signed-off-by: Coline PILOQUET <coline.piloquet@rte-france.com>
@HugoKulesza
Copy link
Collaborator

@colinepiloquet I think there is one left on index.rst when I search for powsybl.org in the code (and 5 more in image metadata but I don't know what they're used for)

@colinepiloquet
Copy link
Member Author

@colinepiloquet I think there is one left on index.rst when I search for powsybl.org in the code (and 5 more in image metadata but I don't know what they're used for)

I think it's ok to leave it in the index.rst, to have a link to the main website somewhere in the introduction.
In the metadata I think it's normal, it comes with the generation of the svg. @So-Fras can you confirm?

@So-Fras
Copy link
Member

So-Fras commented Sep 10, 2024

I think that it is okay to link to the main website in the index.rst, especially since we added a direct link to the readthedocs documentation. As for the svg files, we can leave it as it is for now.

@colinepiloquet colinepiloquet changed the title FIx links redirecting to powsybl website documentation Fix links redirecting to powsybl website documentation Sep 13, 2024
@HugoKulesza HugoKulesza merged commit 90ffaa1 into main Sep 16, 2024
7 checks passed
@HugoKulesza HugoKulesza deleted the fix-dead-links-doc branch September 16, 2024 12:53
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