-
Notifications
You must be signed in to change notification settings - Fork 3k
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 redirection links in docs #9099
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Ariel Otilibili <[email protected]>
Signed-off-by: Ariel Otilibili <[email protected]>
Signed-off-by: Ariel Otilibili <[email protected]>
Signed-off-by: Ariel Otilibili <[email protected]>
Ariel Otilibili seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
CT Test Results 4 files 162 suites 2h 15m 2s ⏱️ For more details on these failures, see this check. Results for commit c8c3772. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts// Erlang/OTP Github Action Bot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Many of these links are to sections within the "OTP Design Principles" Guide, so the link is correct, it is just the description that is a bit missleading. I've added some proposals to make things clearer, what do you think?
@@ -28,7 +28,7 @@ event handlers that are added and deleted dynamically. | |||
An event manager implemented using this module has a standard set of | |||
interface functions and includes functionality for tracing | |||
and error reporting. It also fits into an OTP supervision tree. | |||
For more information, see [OTP Design Principles](`e:system:events.md`). | |||
For more information, see [OTP Design Principles](`e:system:design_principles.md`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For more information, see [OTP Design Principles](`e:system:design_principles.md`). | |
For more information, see [gen_event section in OTP Design Principles](`e:system:events.md`). |
see section Release Handling Instructions in | ||
[OTP Design Principles](`e:system:design_principles.md`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see section Release Handling Instructions in | |
[OTP Design Principles](`e:system:design_principles.md`). | |
see section [Release Handling Instructions in | |
OTP Design Principles](`e:system:release_handling.md#instr`). |
@@ -30,14 +30,14 @@ A generic state machine server process (`gen_statem`) implemented | |||
using this module has a standard set of interface functions | |||
and includes functionality for tracing and error reporting. | |||
It also fits into an OTP supervision tree. For more information, | |||
see [OTP Design Principles](`e:system:statem.md`). | |||
see [OTP Design Principles](`e:system:design_principles.md`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see [OTP Design Principles](`e:system:design_principles.md`). | |
see [gen_statem section in OTP Design Principles](`e:system:statem.md`). |
@@ -1739,7 +1739,7 @@ its internal state during a release upgrade/downgrade, that is, | |||
when the instruction `{update, Module, Change, ...}`, | |||
where `Change = {advanced, Extra}`, is specified in | |||
the [`appup`](`e:sasl:appup.md`) file. For more information, see | |||
[OTP Design Principles](`e:system:release_handling.md#instr`). | |||
[OTP Design Principles](`e:system:design_principles.md#release-handling`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[OTP Design Principles](`e:system:design_principles.md#release-handling`). | |
[Release Handling section in OTP Design Principles](`e:system:release_handling.md#instr`). |
Thanks for the feedback, @garazdawi. Maybe I should explain how I thought the links work.
# git diff master lib/stdlib/src/gen_statem.erl
diff --git a/lib/stdlib/src/gen_statem.erl b/lib/stdlib/src/gen_statem.erl
index 150ba7455b..875374fd7b 100644
--- a/lib/stdlib/src/gen_statem.erl
+++ b/lib/stdlib/src/gen_statem.erl
@@ -30,14 +30,14 @@ A generic state machine server process (`gen_statem`) implemented
using this module has a standard set of interface functions
and includes functionality for tracing and error reporting.
It also fits into an OTP supervision tree. For more information,
-see [OTP Design Principles](`e:system:statem.md`).
+see [OTP Design Principles](`e:system:design_principles.md`).
> #### Note {: .info }
>
> If you are new to `gen_statem` and want an overview
> of concepts and operation the section
> [`gen_statem` Behaviour](`e:system:statem.md`) located in
-> the User's Guide [OTP Design Principles](`e:system:index.html`)
+> the User's Guide [OTP Design Principles](`e:system:design_principles.md`)
> is recommended to read. This reference manual focuses on
> being correct and complete, which might make it hard to see
> the forest for all the trees.
@@ -1739,7 +1739,7 @@ its internal state during a release upgrade/downgrade, that is,
when the instruction `{update, Module, Change, ...}`,
where `Change = {advanced, Extra}`, is specified in
the [`appup`](`e:sasl:appup.md`) file. For more information, see
-[OTP Design Principles](`e:system:release_handling.md#instr`).
+[OTP Design Principles](`e:system:design_principles.md#release-handling`).
For an upgrade, `OldVsn` is `Vsn`, and for a downgrade, `OldVsn` is
`{down, Vsn}`. `Vsn` is defined by the `vsn` attribute(s) |
I agree with you in the bullets above
but here I think the confusion comes. There is indeed a page with a URI called "design_principles", but if you check the title of that page it is the "Overview" page. There are many pages within the Design Principles Guide and the statem page is one of them. You can see which pages are part of the Guide in the navigation bar to the left. |
Gotcha, @garazdawi: Design Principles is a set of pages. I'm updating the PR along your feedback. |
I think you may have forgotten to push your updated? |
Yes, @garazdawi; bear with me, I'm pushing them by tomorrow. |
No rush, just wanted to ping you incase it was a mistake. |
Hello,
gen_statem
, the Note didn't point to the Design Principles