Skip to content

Generate v8 docs with correct project paths #6475

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jul 26, 2022
Merged

Generate v8 docs with correct project paths #6475

merged 3 commits into from
Jul 26, 2022

Conversation

hsubox76
Copy link
Contributor

Changed v8 docgen script so that depending on if "node" or "js" is specified as the script is called, the script will modify theme/layouts/default.hbs to point to the correct _project.yaml.

Sample of the generated files:

First 7 lines of firebase.app.App.html for js/v8:

<!DOCTYPE html>
<html devsite class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<meta name="hide_page_heading" value="true" />
	<meta name="project_path" value="/docs/reference/js/v8/_project.yaml" />

First 7 lines of firebase.app.App.html for node:

<!DOCTYPE html>
<html devsite class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<meta name="hide_page_heading" value="true" />
	<meta name="project_path" value="/docs/reference/node/_project.yaml" />

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

changeset-bot bot commented Jul 25, 2022

⚠️ No Changeset found

Latest commit: dea4e46

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 commented Jul 25, 2022
View reviewed changes
scripts/docgen-compat/theme/layouts/default.hbs
@@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="hide_page_heading" value="true" />
<meta name="project_path" value="/docs/reference/js/_project.yaml" />
<meta name="project_path" value="/docs/reference/node/_project.yaml" />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It doesn't matter what this "value" is set to before the script runs, the docgen script will swap it to the correct one when it runs.

@hsubox76 hsubox76 requested a review from egilmorez July 25, 2022 19:09
@hsubox76 hsubox76 changed the title Ch project yaml Generate v8 docs with correct project paths Jul 25, 2022
@google-oss-bot
Copy link
Contributor

Size Report 1

Affected Products

No changes between base commit (8260149) and merge commit (f47d1b0).

Test Logs

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

egilmorez
egilmorez approved these changes Jul 25, 2022
View reviewed changes
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.

LGTM

I'll go forward and send a couple of CLs to add those project files, thanks!

@google-oss-bot
Copy link
Contributor

Size Analysis Report 1

Affected Products

No changes between base commit (8260149) and merge commit (f47d1b0).

Test Logs

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

dwyfrequency
dwyfrequency approved these changes Jul 26, 2022
View reviewed changes
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

@egilmorez egilmorez merged commit 34c503c into master Jul 26, 2022
@egilmorez egilmorez deleted the ch-project-yaml branch July 26, 2022 16:42
dconeybe pushed a commit that referenced this pull request Jul 26, 2022
@hsubox76 @dconeybe
Generate v8 docs with correct project paths (#6475)
03a9ad8 
* Generate v8 docs with correct project paths

* Make sure to add numbers to regex

* Remove extra file
@firebase firebase locked and limited conversation to collaborators Aug 26, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@egilmorez egilmorez egilmorez approved these changes

@dwyfrequency dwyfrequency dwyfrequency approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@hsubox76 @google-oss-bot @egilmorez @dwyfrequency