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

chore: remove unused configuration for building docs:guide #3879

Merged
merged 4 commits into from
Sep 13, 2021

Conversation

trivikr
Copy link
Member

@trivikr trivikr commented Sep 2, 2021

Background

Running bundle exec rake docs:guide throws the following error:

mkdir -p doc
rm -rf doc/guide
bundle exec yard -q --yardopts .yardopts_guide
...
[warn]: Could not find file: doc-src/guide/index.md
[warn]: Could not find file: doc-src/guide/browser-intro.md
[warn]: Could not find file: doc-src/guide/browser-configuring.md
[warn]: Could not find file: doc-src/guide/browser-services.md
[warn]: Could not find file: doc-src/guide/browser-making-requests.md
[warn]: Could not find file: doc-src/guide/browser-examples.md
[warn]: Could not find file: doc-src/guide/browser-building.md
[warn]: Could not find file: doc-src/guide/browser-configuring-wif.md
[warn]: Could not find file: doc-src/guide/node-intro.md
[warn]: Could not find file: doc-src/guide/node-configuring.md
[warn]: Could not find file: doc-src/guide/node-services.md
[warn]: Could not find file: doc-src/guide/node-making-requests.md
[warn]: Could not find file: doc-src/guide/node-examples.md

This happens because the unused guide was removed in #1384, but the equivalent scripts were not removed.

Description

Removes scripts written for unused guide.
The new Developer Guide is hosted at https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/welcome.html

Testing

Verified that removed docs:all script is not used anywhere.

Checklist
  • run bundle exec rake docs:api and inspect doc/latest/index.html if documentation is changed
  • non-code related change (markdown/git settings etc)

@trivikr trivikr changed the title chore: remove unused scripts for building docs:guide chore: remove unused configuration for building docs:guide Sep 2, 2021
@trivikr trivikr marked this pull request as ready for review September 2, 2021 19:41
@trivikr trivikr merged commit 1106ffe into aws:master Sep 13, 2021
@trivikr trivikr deleted the remove-unused-guide branch September 13, 2021 17:26
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.

2 participants