Skip to content

Update docgen scripts for v1/v2 #1195

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 10 commits into from
Aug 23, 2022
Merged

Update docgen scripts for v1/v2 #1195

merged 10 commits into from
Aug 23, 2022

Conversation

taeold
Copy link
Contributor

@taeold taeold commented Aug 22, 2022

Few changes here:

  1. Fix docgen script for v1 to work with the new file layout

  2. Remove old apidoc scripts - no longer used!

  3. Rewrite toc.ts script to fix the "lowercase" issue where every toc title was lowercased. While I fix the issue here, it also changes the overall toc.yaml structure to return to more flatten structure. I think the output looks fine to me, but we should discuss if we find this revert less desirable.

toc:
  - title: firebase-functions
    path: /docs/functions/beta/reference/firebase-functions.md
    section:
      - title: Alerts
        path: /docs/functions/beta/reference/firebase-functions.alerts.md
      - title: CloudEvent
        path: /docs/functions/beta/reference/firebase-functions.cloudevent.md
      - title: CloudFunction
        path: /docs/functions/beta/reference/firebase-functions.cloudfunction.md
      - title: Database
        path: /docs/functions/beta/reference/firebase-functions.database.md
      - title: Eventarc
        path: /docs/functions/beta/reference/firebase-functions.eventarc.md
      - title: EventHandlerOptions
        path: >-
          /docs/functions/beta/reference/firebase-functions.eventhandleroptions.md
      - title: GlobalOptions
        path: /docs/functions/beta/reference/firebase-functions.globaloptions.md
      - title: Https
        path: /docs/functions/beta/reference/firebase-functions.https.md
      - title: Identity
        path: /docs/functions/beta/reference/firebase-functions.identity.md
      - title: Logger
        path: /docs/functions/beta/reference/firebase-functions.logger.md
      - title: Pubsub
        path: /docs/functions/beta/reference/firebase-functions.pubsub.md
      - title: Storage
        path: /docs/functions/beta/reference/firebase-functions.storage.md
      - title: Tasks
        path: /docs/functions/beta/reference/firebase-functions.tasks.md

@taeold taeold requested a review from egilmorez August 22, 2022 19:37
@taeold taeold added this to the v4 milestone Aug 22, 2022
@taeold
Copy link
Contributor Author

taeold commented Aug 23, 2022

Since @egilmorez is OOO this week and this code change does not affect production code, will merge w/o approval.

@taeold taeold merged commit 51e50c6 into launch.next Aug 23, 2022
@taeold taeold deleted the dl-cf3-docgen-fixes branch August 23, 2022 20:00
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

Successfully merging this pull request may close these issues.

1 participant