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

[DOCS] Enable docs versioning for 0.16.16 #8125

Merged
merged 17 commits into from
Jun 16, 2023

Conversation

anthonyburdi
Copy link
Contributor

@anthonyburdi anthonyburdi commented Jun 15, 2023

Enable docs versioning for 0.16.16 as we prepare to release 0.17.0 by doing the following:

  • Temporarily set onBrokenLinks to 'warn' instead of 'throw' until the broken links listed below are able to be addressed.
  • Handle an import with an absolute path: '/components/warnings/_cli_removal.md'
  • Set NODE_OPTIONS in both netlify and azure-pipelines-docs.yml to avoid JavaScript heap out of memory errors (see also [email protected] Build failure (JavaScript heap out of memory) gatsbyjs/gatsby#15190).
  • Update versioning instructions to temporarily change onBrokenLinks since we reference earlier versions (which will not be available during docs versioning).
  • Increase deprecation warning threshold.

The following will need to be addressed in future PRs:

  • Fix the broken links in the list below from a recent stack trace.
  • Handle all imports with absolute paths (not just '/components/warnings/_cli_removal.md').
  • Remove deprecated code and reduce the threshold to 0.
7:03:18 PM: [ERROR] Unable to build website for locale en.
7:03:18 PM: [ERROR] Error: Docusaurus found broken links!
7:03:18 PM: 
7:03:18 PM: Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
7:03:18 PM: Exhaustive list of all broken links found:
7:03:18 PM: 
7:03:18 PM: - On source page path = /docs/0.16.16/deployment_patterns/how_to_use_gx_with_aws/how_to_use_gx_with_aws_using_athena:
7:03:18 PM:    -> linking to ../../../../docs/guides/validation/index.md#checkpoints (resolved as: /docs/guides/validation/index.md)
7:03:18 PM:    -> linking to ../../../../docs/guides/validation/index.md#actions (resolved as: /docs/guides/validation/index.md)
7:03:18 PM: 
7:03:18 PM: - On source page path = /docs/0.16.16/deployment_patterns/how_to_use_gx_with_aws/how_to_use_gx_with_aws_using_cloud_storage_and_pandas:
7:03:18 PM:    -> linking to ../../../../docs/guides/validation/index.md#checkpoints (resolved as: /docs/guides/validation/index.md)
7:03:18 PM:    -> linking to ../../../../docs/guides/validation/index.md#actions (resolved as: /docs/guides/validation/index.md)
7:03:18 PM: 
7:03:18 PM: - On source page path = /docs/0.16.16/deployment_patterns/how_to_use_gx_with_aws/how_to_use_gx_with_aws_using_redshift:
7:03:18 PM:    -> linking to ../../../../docs/guides/validation/index.md#checkpoints (resolved as: /docs/guides/validation/index.md)
7:03:18 PM:    -> linking to ../../../../docs/guides/validation/index.md#actions (resolved as: /docs/guides/validation/index.md)
7:03:18 PM: 
7:03:18 PM: - On source page path = /docs/0.16.16/deployment_patterns/how_to_use_gx_with_aws/how_to_use_gx_with_aws_using_s3_and_spark:
7:03:18 PM:    -> linking to ../../../../docs/guides/validation/index.md#checkpoints (resolved as: /docs/guides/validation/index.md)
7:03:18 PM:    -> linking to ../../../../docs/guides/validation/index.md#actions (resolved as: /docs/guides/validation/index.md)

@netlify
Copy link

netlify bot commented Jun 15, 2023

Deploy Preview for niobium-lead-7998 canceled.

Name Link
🔨 Latest commit a5171d2
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/648c87e20767010008fef0e1

@ghost
Copy link

ghost commented Jun 15, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

@anthonyburdi anthonyburdi enabled auto-merge (squash) June 15, 2023 23:23
@anthonyburdi anthonyburdi requested a review from a team June 16, 2023 14:51
@anthonyburdi anthonyburdi merged commit fb48f48 into develop Jun 16, 2023
@anthonyburdi anthonyburdi deleted the m/dx-549/enable_docs_versioning_for_0_17_0 branch June 16, 2023 16:59
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.

2 participants