Skip to content

Update api-documenter to work with new devsite changes #6449

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

Merged
merged 4 commits into from
Jul 20, 2022
Merged

Conversation

hsubox76
Copy link
Contributor

Devsite has had some changes and requires some different headers and tags for our reference docs as demonstrated in this CL (internal): https://critique.corp.google.com/cl/461499214

Updating api-documenter to provide this for us, Admin, and Functions. When it is approved, I will publish it to NPM so that Admin and Functions can consume the updates. The update will require an additional command line argument, --project, which will determine the path string pointing at the _project.yaml file.

Also updated JS SDK internal docgen script to call the api-documenter with --project js, plus insert the "do not edit" message in the right place given the new changes.

@hsubox76 hsubox76 requested a review from dwyfrequency as a code owner July 19, 2022 18:16
@changeset-bot
Copy link

changeset-bot bot commented Jul 19, 2022

⚠️ No Changeset found

Latest commit: d027c27

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@hsubox76 hsubox76 requested a review from lahirumaramba July 19, 2022 18:17
@google-oss-bot
Copy link
Contributor

google-oss-bot commented Jul 19, 2022

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Jul 19, 2022

Copy link
Contributor

@dwyfrequency dwyfrequency left a comment

Choose a reason for hiding this comment

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

LGTM

@hsubox76 hsubox76 requested a review from taeold July 19, 2022 20:34
Copy link
Contributor

@taeold taeold left a comment

Choose a reason for hiding this comment

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

Tested the change for functions SDK - works great! Thank you.

@hsubox76 hsubox76 merged commit e4eda86 into master Jul 20, 2022
@hsubox76 hsubox76 deleted the ch-documenter branch July 20, 2022 19:59
@firebase firebase locked and limited conversation to collaborators Aug 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants