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

Add a header comment to devsite md files. #5865

Merged
merged 2 commits into from Jan 11, 2022
Merged

Add a header comment to devsite md files. #5865

merged 2 commits into from Jan 11, 2022

Conversation

hsubox76
Copy link
Contributor

@hsubox76 hsubox76 commented Jan 6, 2022

v9 (current) docs are generated from source code in this repo, and then published to devsite in google3. Occasionally people submit internal CLs to make changes to the generated google3 devsite files. Adding a header to warn them that those changes will be overwritten eventually, and permanent changes should be made in this repo.

A sample generated file by this workflow looks like this (the file is analytics.analytics.md):
https://gist.githubusercontent.com/hsubox76/3e6b95c4b85884716c7a1ac3c77957dc/raw/6864d70fa300fe9eb53187586ffc896e2655fd7a/analytics.analytics.md

@hsubox76 hsubox76 requested a review from allspain as a code owner Jan 6, 2022
@changeset-bot
Copy link

@changeset-bot changeset-bot bot commented Jan 6, 2022

⚠️ No Changeset found

Latest commit: 31bc1ec

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

@google-oss-bot
Copy link
Contributor

@google-oss-bot google-oss-bot commented Jan 6, 2022

Size Report 1

Affected Products

  • @firebase/firestore

    TypeBase (0b385f1)Merge (7a3fc06)Diff
    main426 kB427 kB+261 B (+0.1%)
  • firebase

    TypeBase (0b385f1)Merge (7a3fc06)Diff
    firebase-auth.js411 kB411 kB-28 B (-0.0%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/6TdEKdruJu.html

@google-oss-bot
Copy link
Contributor

@google-oss-bot google-oss-bot commented Jan 6, 2022

Copy link
Contributor

@egilmorez egilmorez left a comment

LG, thanks!

@egilmorez egilmorez merged commit c271d16 into master Jan 11, 2022
19 checks passed
@egilmorez egilmorez deleted the ch-doc-header branch Jan 11, 2022
@firebase firebase locked and limited conversation to collaborators Feb 11, 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.

None yet

4 participants