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

Auto-generate command instructions for README.md #181

Closed
ace-n opened this issue Aug 18, 2016 · 2 comments
Closed

Auto-generate command instructions for README.md #181

ace-n opened this issue Aug 18, 2016 · 2 comments
Assignees
Labels
🚨 This issue needs some love. triage me I really want to be triaged.

Comments

@ace-n
Copy link
Contributor

ace-n commented Aug 18, 2016

Once all our samples are converted to use yargs (or some other arg-parsing library that auto-generates command-line usage instructions), we should consider having a script insert those instructions into our Markdown documentation automatically (instead of manually cutting-and-pasting things).

Thoughts?

@jmdobry
Copy link
Member

jmdobry commented Aug 19, 2016

Things the script needs to know, per product:

  • Product name
  • Product description
  • Setup section
    • Link to any general prerequisites and general "how to run a sample" instructions
    • Extra steps, either defined directly in metadata, or metadata points to a markdown file to be included
  • Samples section
    • Title of sample
    • Links to where it's used in the documentation
    • Links to source code
    • Instructions on how to run it
      • Defined instructions in metadata
      • Specify markdown to be included
      • Specify command to be executed, using the resulting stdout as the instructions

Put metadata in .samples.json file in sample directory. To generate README in that directory, run the script in that directory.

@jmdobry
Copy link
Member

jmdobry commented Aug 21, 2017

Done.

@jmdobry jmdobry closed this as completed Aug 21, 2017
@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Apr 7, 2020
ace-n pushed a commit that referenced this issue Nov 11, 2022
ace-n pushed a commit that referenced this issue Nov 11, 2022
ace-n pushed a commit that referenced this issue Nov 12, 2022
ace-n pushed a commit that referenced this issue Nov 14, 2022
telpirion pushed a commit that referenced this issue Nov 16, 2022
* Re-generate library using /synth.py

* fix(test): v1 now supports object localization, use v1p1beta1 for tests that assert the method doesnt exist

* npm run prettier
unforced pushed a commit that referenced this issue Nov 17, 2022
ace-n pushed a commit that referenced this issue Nov 17, 2022
jsimonweb pushed a commit to jsimonweb/nodejs-docs-samples that referenced this issue Dec 12, 2022
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
kweinmeister pushed a commit that referenced this issue Jan 11, 2023
* build!: Update library to use Node 12
kweinmeister pushed a commit that referenced this issue Jan 11, 2023
🤖 I have created a release *beep* *boop*
---


## [2.0.0](googleapis/nodejs-retail@v1.8.1...v2.0.0) (2022-06-20)


### ⚠ BREAKING CHANGES

* update library to use Node 12 (#181)

### Features

* allow users to disable spell check in search requests ([#183](googleapis/nodejs-retail#183)) ([05005ea](googleapis/nodejs-retail@05005ea))


### Bug Fixes

* **deps:** update dependency @google-cloud/bigquery to v6 ([#186](googleapis/nodejs-retail#186)) ([fc07923](googleapis/nodejs-retail@fc07923))


### Build System

* update library to use Node 12 ([#181](googleapis/nodejs-retail#181)) ([809853f](googleapis/nodejs-retail@809853f))

---
This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚨 This issue needs some love. triage me I really want to be triaged.
Projects
None yet
Development

No branches or pull requests

3 participants