Skip to content

Commit fe216a1

Browse files
authored
feat(docs): Update all config file references to say cedar.toml (#1132)
1 parent b414ae4 commit fe216a1

29 files changed

+84
-84
lines changed

docs/docs/auth/auth0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ AUTH0_REDIRECT_URI="http://localhost:8910"
4444
AUTH0_AUDIENCE="..."
4545
```
4646

47-
Lastly, include all these env vars in the list of env vars that should be available to the web side in `redwood.toml`:
47+
Lastly, include all these env vars in the list of env vars that should be available to the web side in `cedar.toml`:
4848

49-
```toml title="redwood.toml"
49+
```toml title="cedar.toml"
5050
[web]
5151
# ...
5252
includeEnvironmentVariables = [

docs/docs/auth/azure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ AZURE_ACTIVE_DIRECTORY_REDIRECT_URI="http://localhost:8910"
6161
AZURE_ACTIVE_DIRECTORY_LOGOUT_REDIRECT_URI="http://localhost:8910/login"
6262
```
6363

64-
That's it for .env vars. Don't forget to include them in the `includeEnvironmentVariables` array in `redwood.toml`:
64+
That's it for .env vars. Don't forget to include them in the `includeEnvironmentVariables` array in `cedar.toml`:
6565

66-
```toml title="redwood.toml"
66+
```toml title="cedar.toml"
6767
[web]
6868
# ...
6969
includeEnvironmentVariables = [
@@ -152,7 +152,7 @@ AZURE_ACTIVE_DIRECTORY_JWT_ISSUER=https://rwauthtestb2c.b2clogin.com/775527ef-8a
152152
AZURE_ACTIVE_DIRECTORY_KNOWN_AUTHORITY=https://rwauthtestb2c.b2clogin.com
153153
```
154154

155-
And don't forget to add `AZURE_ACTIVE_DIRECTORY_KNOWN_AUTHORITY` to the `includeEnvironmentVariables` array in `redwood.toml`.
155+
And don't forget to add `AZURE_ACTIVE_DIRECTORY_KNOWN_AUTHORITY` to the `includeEnvironmentVariables` array in `cedar.toml`.
156156
(`AZURE_ACTIVE_DIRECTORY_JWT_ISSUER` is only used on the API side. But more importantly, it's sensitive—do _not_ include it in the web side.)
157157

158158
#### Update `activeDirectoryClient` instance

docs/docs/auth/clerk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ CLERK_PUBLISHABLE_KEY="..."
4444
CLERK_SECRET_KEY="..."
4545
```
4646

47-
Lastly, in your project's `redwood.toml` file, include `CLERK_PUBLISHABLE_KEY` in the list of env vars that should be available to the web side:
47+
Lastly, in your project's `cedar.toml` file, include `CLERK_PUBLISHABLE_KEY` in the list of env vars that should be available to the web side:
4848

49-
```toml title="redwood.toml"
49+
```toml title="cedar.toml"
5050
[web]
5151
# ...
5252
includeEnvironmentVariables = [

docs/docs/auth/custom.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ yarn workspace web add @nhost/nhost-js
8383

8484
Then we'll have to make an account, an application, and get it's `backendUrl`.
8585
On your application's dashboard, click "Settings" at the bottom of the the nav on the left, then "Environment Variables", and look for "NHOST_BACKEND_URL".
86-
Copy its value into your project's `.env` file and include it in the list of env vars the web side has access to in your project's `redwood.toml` file:
86+
Copy its value into your project's `.env` file and include it in the list of env vars the web side has access to in your project's `cedar.toml` file:
8787

8888
```bash title=".env"
8989
NHOST_BACKEND_URL="..."
9090
```
9191

92-
```toml title="redwood.toml"
92+
```toml title="cedar.toml"
9393
[web]
9494
# ...
9595
includeEnvironmentVariables = ["NHOST_BACKEND_URL"]
@@ -227,7 +227,7 @@ Time for another trip to your Nhost application's dashboard.
227227
This time you're looking for "NHOST_JWT_SECRET".
228228
Just like "NHOST_BACKEND_URL", it should be in "Settings", "Environment Variables".
229229
(This one is a JSON object, with two properties, `type` and `key`. We just need `key`.)
230-
Add that one to your project's `.env` file (no need to put it in `redwood.toml` though):
230+
Add that one to your project's `.env` file (no need to put it in `cedar.toml` though):
231231

232232
```shell title=".env"
233233
NHOST_JWT_SECRET="..."

docs/docs/auth/firebase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ FIREBASE_PROJECT_ID="..."
3131

3232
Lastly, include `FIREBASE_API_KEY` and `FIREBASE_AUTH_DOMAIN` in the list of env vars that should be available to the web side (`FIREBASE_PROJECT_ID` is for the api side):
3333

34-
```toml title="redwood.toml"
34+
```toml title="cedar.toml"
3535
[web]
3636
# ...
3737
includeEnvironmentVariables = ["FIREBASE_API_KEY", "FIREBASE_AUTH_DOMAIN"]

docs/docs/auth/netlify.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Right now, if we sign up, we'll have to verify our email address.
2727
Let's forego that feature for the purposes of this doc: click "Settings and usage", then scroll down to "Emails" and look for "Confirmation template".
2828
Click "Edit settings", tick the box next to "Allow users to sign up without verifying their email address", and click "Save".
2929

30-
Netlify Identity works a little differently than the other auth providers in that you don't have to copy API keys to your project's `.env` and `redwood.toml` files.
30+
Netlify Identity works a little differently than the other auth providers in that you don't have to copy API keys to your project's `.env` and `cedar.toml` files.
3131
Instead, the first time you use it (by, say, calling `signUp` from `useAuth`), it'll ask you for your app's API endpoint.
3232
So let's go ahead and use it: if this is a brand new project, generate a home page.
3333
There we'll try to sign up by destructuring `signUp` from the `useAuth` hook (import that from `'src/auth'`). We'll also destructure and display `isAuthenticated` to see if it worked:

docs/docs/auth/supabase.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ SUPABASE_KEY="..."
3434
SUPABASE_JWT_SECRET="..."
3535
```
3636

37-
Lastly, in `redwood.toml`, include `SUPABASE_URL` and `SUPABASE_KEY` in the list of env vars that should be available to the web side:
37+
Lastly, in `cedar.toml`, include `SUPABASE_URL` and `SUPABASE_KEY` in the list of env vars that should be available to the web side:
3838

39-
```toml title="redwood.toml"
39+
```toml title="cedar.toml"
4040
[web]
4141
# ...
4242
includeEnvironmentVariables = ["SUPABASE_URL", "SUPABASE_KEY"]

docs/docs/auth/supertokens.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ SUPERTOKENS_GOOGLE_CLIENT_ID=1060725074195-kmeum4crr01uirfl2op9kd5acmi9jutn.apps
6565
SUPERTOKENS_GOOGLE_CLIENT_SECRET=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
6666
```
6767

68-
## `redwood.toml` setup
68+
## `cedar.toml` setup
6969

70-
Make sure to modify `redwood.toml` to pass the required environment variables to the web side:
70+
Make sure to modify `cedar.toml` to pass the required environment variables to the web side:
7171

7272
```toml
7373
[web]

docs/docs/cli-commands.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1090,8 +1090,8 @@ will output the following files, with the components and pages nested in a `Post
10901090
√ Adding scaffold asset imports...
10911091
```
10921092
1093-
If it is not desired to nest the components and pages, then redwood provides an option that you can set to disable this for your project.
1094-
Add the following in your `redwood.toml` file to disable the nesting of components and pages.
1093+
If it is not desired to nest the components and pages, then Cedar provides an option that you can set to disable this for your project.
1094+
Add the following in your `cedar.toml` file to disable the nesting of components and pages.
10951095
10961096
```
10971097
[generate]
@@ -1106,7 +1106,7 @@ Notes:
11061106
11071107
**Namespacing Scaffolds**
11081108
1109-
You can namespace your scaffolds by providing `<path/model>`. The layout, pages, cells, and components will be nested in newly created dir(s). In addition, the nesting folder, based upon the model name, is still applied after the path for components and pages, unless turned off in the `redwood.toml` as described above. For example, given a model `user`, running `yarn redwood generate scaffold admin/user` will nest the layout, pages, and components in a newly created `Admin` directory created for each of the `layouts`, `pages`, and `components` folders:
1109+
You can namespace your scaffolds by providing `<path/model>`. The layout, pages, cells, and components will be nested in newly created dir(s). In addition, the nesting folder, based upon the model name, is still applied after the path for components and pages, unless turned off in the `cedar.toml` as described above. For example, given a model `user`, running `yarn redwood generate scaffold admin/user` will nest the layout, pages, and components in a newly created `Admin` directory created for each of the `layouts`, `pages`, and `components` folders:
11101110
11111111
```plaintext {9-20}
11121112
~/redwood-app$ yarn redwood generate scaffold admin/user
@@ -1167,9 +1167,9 @@ yarn redwood destroy scaffold <model>
11671167
11681168
Notes:
11691169
1170-
1. You can also use `<path/model>` to destroy files that were generated under a scaffold path. For example, `redwood d scaffold admin/post`
1170+
1. You can also use `<path/model>` to destroy files that were generated under a scaffold path. For example, `cedar d scaffold admin/post`
11711171
2. The destroy command will remove empty folders along the path, provided they are lower than the folder level of component, layout, page, etc.
1172-
3. The destroy scaffold command will also follow the `nestScaffoldbyModel` setting in the `redwood.toml` file. For example, if you have an existing scaffold that you wish to destroy, that does not have the pages and components nested by the model name, you can destroy the scaffold by temporarily setting:
1172+
3. The destroy scaffold command will also follow the `nestScaffoldbyModel` setting in the `cedar.toml` file. For example, if you have an existing scaffold that you wish to destroy, that does not have the pages and components nested by the model name, you can destroy the scaffold by temporarily setting:
11731173
11741174
```
11751175
[generate]
@@ -1916,7 +1916,7 @@ Netlify Dev can also create a tunnel from your local development server that all
19161916
# to connect your local project to a site already on Netlify
19171917
# then run netlify dev and our app will be accessible on the port specified below
19181918
framework = "redwoodjs"
1919-
# Set targetPort to the [web] side port as defined in redwood.toml
1919+
# Set targetPort to the [web] side port as defined in cedar.toml
19201920
targetPort = 8910
19211921
# Point your browser to this port to access your CedarJS app
19221922
port = 8888
@@ -1926,7 +1926,7 @@ In order to use [Netlify Dev](https://www.netlify.com/products/dev/) you need to
19261926
19271927
- install the latest [netlify-cli](https://docs.netlify.com/cli/get-started/#installation)
19281928
- use [netlify link](https://docs.netlify.com/cli/get-started/#link-and-unlink-sites) to connect to your Netlify site
1929-
- ensure that the `targetPort` matches the [web] side port in `redwood.toml`
1929+
- ensure that the `targetPort` matches the [web] side port in `cedar.toml`
19301930
- run `netlify dev` and your site will be served on the specified `port` (e.g., 8888)
19311931
- if you wish to share your local server with others, you can run `netlify dev --live`
19321932
@@ -2050,7 +2050,7 @@ If you have not setup the CedarJS server file, it will be setup:
20502050
20512051
```bash
20522052
✔ Adding the experimental server file...
2053-
✔ Adding config to redwood.toml...
2053+
✔ Adding config to cedar.toml...
20542054
✔ Adding required api packages...
20552055
```
20562056
@@ -2094,7 +2094,7 @@ If you have not setup the CedarJS server file, it will be setup:
20942094
20952095
```bash
20962096
✔ Adding the experimental server file...
2097-
✔ Adding config to redwood.toml...
2097+
✔ Adding config to cedar.toml...
20982098
✔ Adding required api packages...
20992099
```
21002100
@@ -2206,7 +2206,7 @@ Runs a server that only serves the api side.
22062206
yarn rw serve api
22072207
```
22082208
2209-
This command uses `apiUrl` in your `redwood.toml`. Use this command if you want to run just the api side on a server (e.g. running on Render).
2209+
This command uses `apiUrl` in your `cedar.toml`. Use this command if you want to run just the api side on a server (e.g. running on Render).
22102210
22112211
| Arguments & Options | Description |
22122212
| ------------------- | ----------------------------------------------------------------- |
@@ -2235,11 +2235,11 @@ This command serves the contents in `web/dist`. Use this command if you're debug
22352235
>
22362236
> Probably, but it can be a challenge to setup when you just want something running quickly!
22372237
2238-
| Arguments & Options | Description |
2239-
| ------------------- | ------------------------------------------------------------------------------------- |
2240-
| `--port` | What port should the server run on [default: 8911] |
2241-
| `--socket` | The socket the server should run. This takes precedence over port |
2242-
| `--apiHost` | Forwards requests from the `apiUrl` (defined in `redwood.toml`) to the specified host |
2238+
| Arguments & Options | Description |
2239+
| ------------------- | ----------------------------------------------------------------------------------- |
2240+
| `--port` | What port should the server run on [default: 8911] |
2241+
| `--socket` | The socket the server should run. This takes precedence over port |
2242+
| `--apiHost` | Forwards requests from the `apiUrl` (defined in `cedar.toml`) to the specified host |
22432243
22442244
If you want to format your log output, you can pipe the command to the Cedar LogFormatter:
22452245
@@ -2285,7 +2285,7 @@ yarn redwood upgrade -t 0.19.3
22852285
The CLI can check for things in the background, like new versions of the framework, while you dev.
22862286
22872287
Right now it can only check for new versions.
2288-
If you'd like it to do so, set `notifications.versionUpdates` in the `redwood.toml` file to include an array of the tags you're interested in hearing about.
2288+
If you'd like it to do so, set `notifications.versionUpdates` in the `cedar.toml` file to include an array of the tags you're interested in hearing about.
22892289
(The former has priority.)
22902290
22912291
By default, the CLI won't check for upgrades—you have to opt into it.

docs/docs/contributing-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ How To's are tutorial-style content focused on a specific problem-solution. They
133133

134134
If you write it, will they read it? We think they will&mdash;if they can find it.
135135

136-
After you've finished writing, step back for a moment and consider the word(s) or phrase(s) people will use to find what you just wrote. For example, let's say you were writing a doc about configuring a Cedar app. If you didn't know much about configuring a Cedar app, a heading (in the nav bar to the left) like "redwood.toml" wouldn't make much sense, even though it _is_ the main configuration file. You'd probably look for "Cedar Config" or "Settings", or type "how to change Cedar App settings" in the "Search the docs" bar up top, or in Google.
136+
After you've finished writing, step back for a moment and consider the word(s) or phrase(s) people will use to find what you just wrote. For example, let's say you were writing a doc about configuring a Cedar app. If you didn't know much about configuring a Cedar app, a heading (in the nav bar to the left) like "cedar.toml" wouldn't make much sense, even though it _is_ the main configuration file. You'd probably look for "Cedar Config" or "Settings", or type "how to change Cedar App settings" in the "Search the docs" bar up top, or in Google.
137137

138138
That is to say, the most useful headings aren't always the most literal ones. Indexing is more than just underlining the "important" words in a text&mdash;it's identifying and locating the concepts and topics that are the most relevant to our readers, the users of our documentation.
139139

0 commit comments

Comments
 (0)