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

Docs: mark methods and products that don't work in Node #7276

Merged
merged 14 commits into from
May 26, 2023
Merged

Conversation

hsubox76
Copy link
Contributor

@hsubox76 hsubox76 commented May 2, 2023

We want to get rid of the "Node.js (Client)" sidebar entry in the reference docs and have one unified entry each for modular (the entry called "Javascript - modular") and compat (the entry called ("Javascript - compat (namespaced)"). Modular already did not have a separate entry for Node.

The only difference between the namespaced "JavaScript - compat" and namespaced "Node" docs were that the "Node" docs had some methods and products removed, as they don't work in Node.

This PR adds sentences on each product and method that doesn't work in Node, allowing us to use one set of docs for both "browser" and "Node" users (and any other environments).

The content changes are:

  • Added sentences to the index page of each product that doesn't work in Node (Analytics, Messaging, Performance, Remote Config, Installations) and an explanation of the narrow circumstances where you can use App Check in Node.
  • Added sentences to Auth and Firestore methods/classes/properties that don't work in Node.
  • There was a change a while ago that forgot to add StorageErrorCode to the compat TOC, I did that.

Script changes are:

  • I removed all the script stuff relating to Node docgen option (this is all in the directory scripts/docgen-compat)

Some tips for parsing:

  • Anything with a packageDocumentation tag is text that appears at the top of a product's main index page
  • Every (content) file change here is for the modular docs except packages/firebase/compat/index.d.ts which is the sole source of truth for compat docs. That file already had non-Node APIs marked with a @webonly tag which allowed the documentation tool to filter them out when creating the separate Node docs. I replaced those tags with text that will be visible in the reference docs.
  • @remarks tag means that everything after it is excluded from table of contents entries, to save space, but appears in the full description of the item itself.

@changeset-bot
Copy link

changeset-bot bot commented May 2, 2023

⚠️ No Changeset found

Latest commit: a7124e2

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 commented May 2, 2023

@google-oss-bot
Copy link
Contributor

google-oss-bot commented May 2, 2023

Copy link
Contributor

@prameshj prameshj left a comment

Choose a reason for hiding this comment

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

lgtm, except for one comment.

docs-devsite/auth.md Outdated Show resolved Hide resolved
docs-devsite/auth.md Outdated Show resolved Hide resolved
packages/analytics/src/index.ts Outdated Show resolved Hide resolved
packages/installations/src/index.ts Outdated Show resolved Hide resolved
@MarkDuckworth MarkDuckworth self-assigned this May 4, 2023
Copy link
Contributor

@egilmorez egilmorez left a comment

Choose a reason for hiding this comment

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

We also chatted about this offline, but added my observations here too. Thanks for sending this PR!

packages/firebase/compat/index.d.ts Outdated Show resolved Hide resolved
packages/firestore/src/api/settings.ts Show resolved Hide resolved
Copy link
Contributor

@MarkDuckworth MarkDuckworth left a comment

Choose a reason for hiding this comment

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

I opened 7299 with additional changes for Firestore. But otherwise, Firestore looks good to me.

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 merged commit e642fc7 into master May 26, 2023
20 of 22 checks passed
@hsubox76 hsubox76 deleted the ch-nonode branch May 26, 2023 19:34
@firebase firebase locked and limited conversation to collaborators Jun 26, 2023
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

8 participants