Skip to content

Conversation

escii
Copy link
Collaborator

@escii escii commented Apr 28, 2024

@escii escii requested a review from tonyblank April 28, 2024 23:30
…tro-breadcrumb

# Conflicts:
#	astro/src/content/docs/_shared/_admin-user-form.mdx
#	astro/src/content/docs/_shared/_admin-user-registration-form.mdx
tonyblank
tonyblank previously approved these changes May 17, 2024
Copy link

@tonyblank tonyblank left a comment

Choose a reason for hiding this comment

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

LGTM - so many breadcrumbs, I feel like a duck!

@Aaron-Ritter
Copy link
Contributor

Aaron-Ritter commented May 18, 2024

thanks for the review @tonyblank while merging the latest updates i found a mistake in a few changes we did where it should have been replaced with <UIelement></UIelement> instead.

@Aaron-Ritter
Copy link
Contributor

@alex-fusionauth I've merged the latest changes and updated some newly introduced <strong> tags and we are ready to merge. As discussed, while reviewing for any other changes the single step navigation instructions. I've update all these accordingly as well with the <Breadcrumb> tag.

The few ones unclear right now are the ones where it refers to navigate to a section rather a full page/tab.

@Aaron-Ritter
Copy link
Contributor

@alex-fusionauth defined the sections as a <InlineUIElement>

@andrewpai
Copy link
Contributor

andrewpai commented Jul 5, 2024

Here is a file of lines that in most cases need <Breadcrumb> instead of some other styling. A few need <InlineUIElement>.
breadcrumbs-needed.txt

@Aaron-Ritter Aaron-Ritter requested a review from andrewpai July 9, 2024 07:32
@Aaron-Ritter
Copy link
Contributor

Aaron-Ritter commented Jul 11, 2024

Here is a file of lines that in most cases need <Breadcrumb> instead of some other styling. A few need <InlineUIElement>. breadcrumbs-needed.txt

@andrewpai Working on this at the moment, and wanted to clarify, we will not only change the site content but all blog posts too with the same concept. And according to that i will update the blog section in DocsDevREADME.md with that guideline too.

@andrewpai
Copy link
Contributor

Here is a file of lines that in most cases need <Breadcrumb> instead of some other styling. A few need <InlineUIElement>. breadcrumbs-needed.txt

@andrewpai Working on this at the moment, and wanted to clarify, we will not only change the site content but all blog posts too with the same concept. And according to that i will update the blog section in DocsDevREADME.md with that guideline too.

Correct, we should make our docs consistent across /docs, /blog, and /articles.

@escii escii requested review from a team as code owners November 25, 2024 13:45
@Aaron-Ritter
Copy link
Contributor

Aaron-Ritter commented Feb 27, 2025

Thanks @andrewpai,

We will go ahead and define a read-only form field as InlineField as it is still a form field.

- If you are referencing a field in a form or JSON API doc, use the [InlineField](astro/src/components/InlineField.astro) component: `<InlineField>Issuer</InlineField>`.

If it comes to the field input, we go ahead and use the <strong> tag everywhere unless you want to create a custom tag.

@andrewpai We discovered the issue that linting will complain about the usage of <strong> tags in mdx files:

> [email protected] lint
> eslint src/content/blog/swift-sdk-beta.mdx src/content/docs/sdks/android-sdk.mdx src/content/docs/sdks/swift-sdk.mdx src/content/quickstarts/quickstart-swift-ios-native-appauth.mdx src/content/quickstarts/quickstart-swift-ios-native.mdx


/home/runner/work/fusionauth-site/fusionauth-site/astro/src/content/quickstarts/quickstart-swift-ios-native.mdx
  63:56   error  Unexpected HTML tag [strong], use markdown instead  remark-lint-no-html
  63:139  error  Unexpected HTML tag [strong], use markdown instead  remark-lint-no-html

# Conflicts:
#	astro/src/content/docs/_shared/_account-portal.mdx
#	astro/src/content/docs/apis/api-explorer.mdx
#	astro/src/content/docs/apis/login.mdx
#	astro/src/content/docs/apis/users.mdx
#	astro/src/content/docs/customize/look-and-feel/simple-theme-editor.mdx
#	astro/src/content/docs/extend/events-and-webhooks/index.mdx
#	astro/src/content/docs/extend/events-and-webhooks/signing.mdx
#	astro/src/content/docs/extend/examples/5-minute-intro/5-minute-fastpath.mdx
#	astro/src/content/docs/extend/examples/api-gateways/aws-api-gateway.mdx
#	astro/src/content/docs/extend/examples/api-gateways/ngrok-cloud-edge.mdx
#	astro/src/content/docs/get-started/_setting-up-portal-account.mdx
#	astro/src/content/docs/get-started/core-concepts/_multi-tenant-limitations.mdx
#	astro/src/content/docs/get-started/core-concepts/licensing.mdx
#	astro/src/content/docs/get-started/core-concepts/users.mdx
#	astro/src/content/docs/get-started/download-and-install/kubernetes/gke.mdx
#	astro/src/content/docs/get-started/run-in-the-cloud/github-actions.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/identity-providers/enterprise/okta-samlv2-idp-initiated.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/identity-providers/enterprise/samlv2-idp-initiated.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/identity-providers/overview-oidc.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/identity-providers/overview-samlv2.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/apple.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/identity-providers/social/google.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/login-api/json-web-tokens.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/multi-factor-authentication.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/oauth/modes.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/passwordless/magic-links.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/setting-up-user-account-lockout.mdx
#	astro/src/content/docs/lifecycle/authenticate-users/single-sign-on.mdx
#	astro/src/content/docs/lifecycle/manage-users/account-management/_account-management-troubleshooting.mdx
#	astro/src/content/docs/lifecycle/manage-users/account-management/customizing-account-management.mdx
#	astro/src/content/docs/lifecycle/manage-users/search/user-search-with-elasticsearch.mdx
#	astro/src/content/docs/lifecycle/manage-users/user-actions.mdx
#	astro/src/content/docs/lifecycle/manage-users/verification/_common-questions-gating.mdx
#	astro/src/content/docs/lifecycle/migrate-users/connectors/generic-connector.mdx
#	astro/src/content/docs/lifecycle/migrate-users/general-migration.mdx
#	astro/src/content/docs/lifecycle/migrate-users/provider-specific/cognito.mdx
#	astro/src/content/docs/lifecycle/migrate-users/provider-specific/wordpress.mdx
#	astro/src/content/docs/lifecycle/migrate-users/scim/scim-sdk.mdx
#	astro/src/content/docs/operate/deploy/cluster.mdx
#	astro/src/content/docs/operate/deploy/user-support-guide.mdx
#	astro/src/content/docs/operate/secure/advanced-threat-detection.mdx
#	astro/src/content/docs/operate/troubleshooting/troubleshooting.mdx
#	astro/src/content/quickstarts/quickstart-swift-ios-native.mdx
@Aaron-Ritter
Copy link
Contributor

Aaron-Ritter commented Mar 26, 2025

@synedra @andrewpai @mooreds I would like to get this PR merged, after spending another 5 hours on it getting everything merged from main, and all strong, Breadcrumb, InlineField or InlineUIElement eslint errors fixed.

On the eslint topic: I've run a check on all changed files and created a fix for the pr-linting #3600.

The part which is still outstanding on how to handle the input in to InlineField as we cant use strong we need an additional definition for that e.g. InlineFieldInput. But I would suggest since we’re already having 311 files changed that we do this in a second iteration.

@Aaron-Ritter
Copy link
Contributor

@andrewpai as discussed I merged the latest changes, updated all the newly added old-style breadcrumbs. In addition, I fixed some of the obvious link errors throughout the documents modified in this PR.

@mooreds mooreds dismissed andrewpai’s stale review April 15, 2025 18:55

Chatted with him in slack.

@mooreds mooreds merged commit 34e283a into FusionAuth:main Apr 15, 2025
2 of 4 checks passed
@Aaron-Ritter Aaron-Ritter deleted the fix/astro-breadcrumb branch April 15, 2025 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants