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 redirection links in docs #9099

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ariel-anieli
Copy link

@ariel-anieli ariel-anieli commented Nov 21, 2024

Hello,

  • here are commits for fixing redirection links
  • it started from noticing that, in gen_statem, the Note didn't point to the Design Principles
  • noticed the same pattern in other files.
# git grep -Pn '\[OTP Design Principles\]'

lib/kernel/doc/kernel_app.md:50:manager (see [OTP Design Principles](`e:system:design_principles.md`) and
lib/kernel/doc/references/app.md:173:  information, see [OTP Design Principles](`e:system:applications.md`).
lib/kernel/doc/references/config.md:150:[OTP Design Principles](`e:system:design_principles.md`)
lib/kernel/src/application.erl:43:[OTP Design Principles](`e:system:design_principles.md`).
lib/kernel/src/application.erl:47:[OTP Design Principles](`e:system:design_principles.md`),
lib/kernel/src/error_logger.erl:38:[OTP Design Principles](`e:system:design_principles.md`) and `m:gen_event`),
lib/sasl/doc/guides/sasl_intro.md:36:section [OTP Design Principles](`e:system:index.html`) in _System
lib/sasl/doc/references/appup.md:82:[OTP Design Principles](`e:system:release_handling.md`) in _System
lib/sasl/src/release_handler.erl:29:[OTP Design Principles](`e:system:release_handling.md`) in _System
lib/sasl/src/release_handler.erl:215:[OTP Design Principles](`e:system:index.html`),
lib/stdlib/src/gen_event.erl:31:For more information, see [OTP Design Principles](`e:system:events.md`).
lib/stdlib/src/gen_event.erl:366:For more information, see [OTP Design Principles](`e:system:index.html`).
lib/stdlib/src/gen_fsm.erl:209:see [OTP Design Principles](`e:system:design_principles`).
lib/stdlib/src/gen_fsm.erl:683:[OTP Design Principles](`e:system:release_handling.md#instr`).
lib/stdlib/src/gen_statem.erl:33:see [OTP Design Principles](`e:system:statem.md`).
lib/stdlib/src/gen_statem.erl:40:> the User's Guide [OTP Design Principles](`e:system:index.html`)
lib/stdlib/src/gen_statem.erl:1742:[OTP Design Principles](`e:system:release_handling.md#instr`).
lib/stdlib/src/proc_lib.erl:26:[OTP Design Principles](`e:system:design_principles.md`). Specifically, the
system/doc/README.md:12:* [OTP Design Principles](design_principles/design_principles.md) -
system/doc/getting_started/conc_prog.md:626:  [OTP Design Principles](`e:system:design_principles.md`)).
system/doc/reference_manual/modules.md:167:[OTP Design Principles](`e:system:spec_proc.md#behaviours`).
system/doc/reference_manual/ref_man_processes.md:504:[OTP Design Principles](`e:system:design_principles.md`)
system/doc/system_principles/system_principles.md:141:[OTP Design Principles](`e:system:release_handling.md`) and the

Ariel Otilibili added 4 commits November 21, 2024 12:12
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


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.

Copy link
Contributor

github-actions bot commented Nov 21, 2024

CT Test Results

    4 files    162 suites   2h 15m 2s ⏱️
3 707 tests 3 419 ✅ 286 💤 2 ❌
4 358 runs  4 016 ✅ 340 💤 2 ❌

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

Copy link
Contributor

@garazdawi garazdawi left a 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?

lib/kernel/doc/references/app.md Show resolved Hide resolved
lib/sasl/doc/references/appup.md Show resolved Hide resolved
lib/sasl/src/release_handler.erl Show resolved Hide resolved
@@ -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`).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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`).

Comment on lines +682 to +683
see section Release Handling Instructions in
[OTP Design Principles](`e:system:design_principles.md`).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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`).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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`).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[OTP Design Principles](`e:system:design_principles.md#release-handling`).
[Release Handling section in OTP Design Principles](`e:system:release_handling.md#instr`).

@ariel-anieli
Copy link
Author

ariel-anieli commented Nov 22, 2024

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?

Thanks for the feedback, @garazdawi. Maybe I should explain how I thought the links work.
Tell me, does it makes sense?

# 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)

@garazdawi
Copy link
Contributor

Maybe I should explain how I thought the links work. Tell me, does it makes sense?

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.

image

@ariel-anieli
Copy link
Author

Gotcha, @garazdawi: Design Principles is a set of pages. I'm updating the PR along your feedback.

@garazdawi
Copy link
Contributor

I think you may have forgotten to push your updated?

@ariel-anieli
Copy link
Author

I think you may have forgotten to push your updated?

Yes, @garazdawi; bear with me, I'm pushing them by tomorrow.

@garazdawi
Copy link
Contributor

No rush, just wanted to ping you incase it was a mistake.

@IngelaAndin IngelaAndin added the team:VM Assigned to OTP team VM label Nov 25, 2024
@garazdawi garazdawi self-assigned this Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team:VM Assigned to OTP team VM
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants