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

Fixing bugs related to links in Quickstarts + minor fixes #10511

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

Conversation

mchang16-auth
Copy link
Contributor

@mchang16-auth mchang16-auth commented Feb 26, 2025

Changes made:

  • Fixed a bug introduced in Updating links in Quickstarts to open in new tab #10505 where the the {} brackets were removed around template variables in the URL string, causing the link to be broken (I have fixed the script to not have this happen in the future).
  • Updated outdated or broken URLs
  • Fixing the syntax for bolded links
  • For Flutter Quickstart, the Next Steps section was including links that only belong in the Dashboard Quickstart version
  • Grammar spelling fix (added a needed apostrophe)
  • Updated some snippets used in Quickstart guides to open their links in a new tab
  • Set links to not open in a new tab if it is referencing part of the existing Quickstart article that the user is currently on
  • Fixing some edge cases where the automated scripted messed up the link conversion
  • Fixing a typo where the '$' was not correctly placed in front of the variable ({$account.namespace} -> ${account.namespace}

Please see commits for a more organized look of what was changed.

Testing

  • This has been tested locally and also compared with what is currently in production for both the auth0.com/docs and the Manage Dashboard Quickstarts. I have manually gone through each Quickstart to make sure the links are all working as expected.

@@ -107,7 +107,7 @@ To make your endpoint return a JSON, you can use a Java record. The member varia

## Create the API controller {{{ data-action=code data-code="APIController.java" }}}

Create a new class named `APIController` to handle requests to the endpoints. The `APIController` has three routes as defined in the <a href="/quickstart/backend/java-spring-security5/interactive/#configure-the-resource-server" target="_blank" rel="noreferrer">Protect API Endpoints</a> section. For this example, allow all origins through `@CrossOrigin` annotation. Real applications should configure `CORS` for their use case.
Create a new class named `APIController` to handle requests to the endpoints. The `APIController` has three routes as defined in the [Protect API Endpoints](/quickstart/backend/java-spring-security5/interactive/#configure-the-resource-server) section. For this example, allow all origins through `@CrossOrigin` annotation. Real applications should configure `CORS` for their use case.

Copy link
Contributor Author

@mchang16-auth mchang16-auth Feb 26, 2025

Choose a reason for hiding this comment

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

Here I am changing these links to not open in a new tab since it is referencing part of the page that the user is currently on. I will note that in the Dashboard Quickstarts, these type of self-referencing links do not work because of it being in a embedded iframe (you can try this out in the Device Auth Flow dashboard quickstart to see it not working). That is why I only have them internally open only for the interactive Quickstarts on the Auth0 Docs site. This is something to make a note of when discussing whether we should move away from using an iframe for Quickstarts or not.

@@ -8,4 +8,4 @@ Run the following command within your project directory to install the Auth0 Rea
npm install @auth0/auth0-react
```

The SDK exposes methods and variables that help you integrate Auth0 with your React application idiomatically using <a href="https://reactjs.org/docs/hooks-overview.html" target="_blank" rel="noreferrer">React Hooks</a> or <a href="https://reactjs.org/docs/higher-order-components.html" target="_blank" rel="noreferrer">Higher-Order Components</a>.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here and in other files I replace the URL because it references an outdated URL and takes the user to either a deprecated docs page or a 404 not found page. I tried my best to find the updated, modern version of these sites to replace the old ones with.

@mchang16-auth mchang16-auth marked this pull request as ready for review February 26, 2025 23:00
@mchang16-auth mchang16-auth changed the title Dxaa 164 Fixing bugs related to links in Quickstarts + minor fixes Feb 26, 2025
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.

1 participant