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: move region tags to fix docs #3100

Closed
wants to merge 2 commits into from
Closed

docs: move region tags to fix docs #3100

wants to merge 2 commits into from

Conversation

camiekim
Copy link
Contributor

@camiekim camiekim commented Apr 3, 2023

Per b/276737524

@camiekim camiekim requested review from a team as code owners April 3, 2023 15:30
@snippet-bot
Copy link

snippet-bot bot commented Apr 3, 2023

Here is the summary of changes.

You are about to add 2 region tags.
You are about to delete 2 region tags.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label bot added samples Issues that are directly related to samples. api: workflows Issues related to the Workflows API. labels Apr 3, 2023
Copy link
Contributor

@iennae iennae left a comment

Choose a reason for hiding this comment

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

  1. We shouldn't touch index.js; it's auto-generated

  2. Removing the comment and moving the region tag I think breaks a standard we have to let the developer uncomment these out. I think that the problem is line 32 in the original file should probably be documenting const workflowName = 'myFirstWorkflow';

3 Do you happen to know why we have this quickstart as well as the one in the level above labeled quickstart.js ? These are different quickstarts and it confused me at first, so I think that might be distracting to others as well.

@camiekim
Copy link
Contributor Author

camiekim commented Apr 5, 2023

Thanks, Jennifer. I'll close this PR and open a new one. Regarding why there are two samples, workflows/quickstart.js is used in https://cloud.google.com/workflows/docs/reference/libraries and workflows/quickstart/index.js is used in https://cloud.google.com/workflows/docs/execute-workflow-client-libraries. I'll look into why this is and cleaning up as appropriate.

@camiekim camiekim closed this Apr 5, 2023
@camiekim camiekim deleted the fix-docs branch April 5, 2023 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: workflows Issues related to the Workflows API. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants