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

[v16] Fix docs markup errors #42603

Closed

Conversation

iAdramelk
Copy link
Contributor

Update of #42512 based on v16 branch. These changes should also be backported to master.

Some fixes for the docs to fix validation errors and warnings in Docusaurus:

  • Remove duplicate redirects.
  • Remove redirects form existing pages.
  • Update redirects leading to non-existing pages.
  • Fix damaged svg image (can't read width and height).
  • Add .mdx extension to links to make possible to validate links.
  • Fixed typo in docs/pages/access-controls/access-request-plugins/servicenow.mdx inline code.
  • Fixed typo in docs/pages/reference/terraform-provider.mdx that was causing mdx failing. (But this is an auto-generated file, so it's better to fix it in the original location too).
  • Fixed dbname key for tctl-auth-sign-3-files.mdx includes to make them work.

Didn't fix, but should be fixed separately:

  • Link to includes/dynamodb-iam-policy.mdx in CHANGELOG.md – files in includes folder does not build to full pages in docs.
  • Three images are used in docs, but are missing in the filesystem:
    • /docs/img/database-access/guides/cloudsql/instance-id@2x.png
    • /docs/img/database-access/guides/cloudsql/instance-public-ip@2x.png
    • /docs/img/desktop-access/install-active-directory.png

@zmb3 zmb3 changed the title Fix docs markup errors for v16 [v16] Fix docs markup errors Jun 7, 2024
@ptgott
Copy link
Contributor

ptgott commented Jun 11, 2024

Going to create a buddy PR for this

@iAdramelk
Copy link
Contributor Author

Hey. What are our next steps on these PRs? I see approvals, but some of the CI task are still falling and also @ptgott wrote that he wants to create buddy PRs for them. What needs to do what next to make these changes merged

@rosstimothy
Copy link
Contributor

rosstimothy commented Jun 20, 2024

External contributions are unable to be accepted directly because CI will not run. @ptgott opened a "buddy" PR which will be merged to master, and then backported to branch/v16, branch/v15, and branch/v14. You will retain authorship of your commits. I'll close this for now to eliminate confusion.

@iAdramelk
Copy link
Contributor Author

@rosstimothy got it!

Can we do the same with #42510 and #42509 then?

@rosstimothy
Copy link
Contributor

@iAdramelk feel free to close those PRs. @ptgott will take care of backporting the changes to release branches after they land in master.

@iAdramelk
Copy link
Contributor Author

@rosstimothy I will close them for now. JFY, they have different set of changes. Some changes which were needed for the older versions are not needed in master and vice versa.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants