Skip to content

Commit

Permalink
Web Frameworks docs formatting for DevSite (#5645)
Browse files Browse the repository at this point in the history
* Removing slashes and editing the linter ignore file to allow them (as required by DevSite).
  • Loading branch information
egilmorez committed Apr 3, 2023
1 parent 9714a6f commit 0a681c2
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 15 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,5 +124,6 @@ module.exports = {
"src/dynamicImport.js",
"scripts/webframeworks-deploy-tests/hosting/**",
"scripts/frameworks-tests/vite-project/**",
"/src/frameworks/docs/**",
],
};
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
/lib/**/*
/CONTRIBUTING.md
/scripts/frameworks-tests/vite-project/**
/src/frameworks/docs/**
10 changes: 5 additions & 5 deletions src/frameworks/docs/angular.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Project: /docs/hosting/\_project.yaml
Book: /docs/\_book.yaml
Project: /docs/hosting/_project.yaml
Book: /docs/_book.yaml
page_type: guide

{% include "_shared/apis/console/_local_variables.html" %}
Expand All @@ -13,13 +13,13 @@ page_type: guide
With the Firebase framework-aware {{cli}}, you can deploy your Angular application
to Firebase and serve dynamic content to your users.

<<\_includes/\_preview-disclaimer.md>>
<<_includes/_preview-disclaimer.md>>

<<\_includes/\_before-you-begin.md>>
<<_includes/_before-you-begin.md>>

- Optional: AngularFire

<<\_includes/\_initialize-firebase.md>>
<<_includes/_initialize-firebase.md>>

1. Choose your hosting source directory; this could be an existing Angular app.
1. Choose "Dynamic web hosting with web framework."
Expand Down
10 changes: 5 additions & 5 deletions src/frameworks/docs/express.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Project: /docs/hosting/\_project.yaml
Book: /docs/\_book.yaml
Project: /docs/hosting/_project.yaml
Book: /docs/_book.yaml
page_type: guide

{% include "_shared/apis/console/_local_variables.html" %}
Expand All @@ -14,14 +14,14 @@ With some additional configuration, you can build on the basic
framework-aware {{cli}} functionality
to extend integration support to frameworks other than Angular and Next.js.

<<\_includes/\_preview-disclaimer.md>>
<<_includes/_preview-disclaimer.md>>

<<\_includes/\_before-you-begin.md>>
<<_includes/_before-you-begin.md>>

- Optional: Billing enabled on your Firebase project
(required if you plan to use SSR)

<<\_includes/\_initialize-firebase.md>>
<<_includes/_initialize-firebase.md>>

1. Choose your hosting source directory; this could be an existing web app.
1. Choose "Dynamic web hosting with web framework."
Expand Down
10 changes: 5 additions & 5 deletions src/frameworks/docs/nextjs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Project: /docs/hosting/\_project.yaml
Book: /docs/\_book.yaml
Project: /docs/hosting/_project.yaml
Book: /docs/_book.yaml
page_type: guide

{% include "_shared/apis/console/_local_variables.html" %}
Expand All @@ -16,16 +16,16 @@ translates them to Firebase settings with zero or minimal extra configuration on
your part. If your app includes dynamic server-side logic, the {{cli}} deploys that
logic to {{cloud_functions_full}}.ß

<<\_includes/\_preview-disclaimer.md>>
<<_includes/_preview-disclaimer.md>>

<<\_includes/\_before-you-begin.md>>
<<_includes/_before-you-begin.md>>

- Optional: Billing enabled on your Firebase project
(required if you plan to use SSR)
- Optional: use the experimental ReactFire library to benefit from its
Firebase-friendly features

<<\_includes/\_initialize-firebase.md>>
<<_includes/_initialize-firebase.md>>

1. Choose your hosting source directory. If this an existing Next.js app,
the {{cli}} process completes, and you can proceed to the next section.
Expand Down

0 comments on commit 0a681c2

Please sign in to comment.