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

feat(docs): document how to generate and push documentation for a single component/version #6836

Open
bshaffer opened this issue Dec 1, 2023 · 0 comments

Comments

@bshaffer
Copy link
Contributor

bshaffer commented Dec 1, 2023

In order to enable versioning in our refdocs, we must be able to deploy a component version in the past (in the case of bug fixes). This is always possible, so we need to include the documentation somewhere. Add the documentation below somewhere (probably in the dev dir, or on our internal teams page).

The steps go something like this:

  1. check out this repo and go into the "dev" directory
    cd google-cloud-php/dev
  2. Create a new "build" directory to install the component/version
    mkdir build
  3. install the component and version you want to generate docs for (in this case, it's google/cloud-vision v1.2.0)
    composer require google/cloud-vision:1.2.0 -d build
  4. run the docfx command, setting the component path to the vendored package. Set the staging bucket and metadata version if you want to upload it
    ./google-cloud docfx \
      --component Vision \
      --component-path=build/vendor/google/cloud-vision \
      --metadata-version=1.2.0 \
      --staging-bucket=docs-staging-v2-dev

You're done!

@bshaffer bshaffer changed the title feat: document how to generate and push documentation for a single component/version feat(docs): document how to generate and push documentation for a single component/version Dec 1, 2023
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

No branches or pull requests

1 participant