Skip to content

Commit a1931a1

Browse files
committed
removed old instructions for adding config parameters
1 parent 128bf02 commit a1931a1

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,6 @@ RUN chmod +x /docker-entrypoint-initdb.d/setup-dbs.sh
9494

9595
Note that the script above will ONLY be executed during initialization of the container with no data in the database, see the official [Postgres image](https://hub.docker.com/_/postgres) for details. If you want to use the script to run again be sure there is no data in the /var/lib/postgresql/data of the container.
9696

97-
### Generate Parse Server Config Definition
98-
99-
If you want to make changes to [Parse Server Configuration][config] add the desired configuration to [src/Options/index.js][config-index] and run `npm run definitions`. This will output [src/Options/Definitions.js][config-def] and [src/Options/docs.js][config-docs].
100-
101-
To view docs run `npm run docs` and check the `/out` directory.
102-
10397
## Feature Considerations
10498
### Security Checks
10599

@@ -133,13 +127,14 @@ Introducing new Parse Errors requires the following steps:
133127

134128
### Parse Server Configuration
135129

136-
Introducing new Parse Server configuration parameters requires the following steps:
130+
Introducing new [Parse Server configuration][config] parameters requires the following steps:
137131

138-
1. Add parameters definitions in [/src/Options/index.js](https://github.com/parse-community/parse-server/blob/master/src/Options/index.js).
132+
1. Add parameters definitions in [/src/Options/index.js][config-index].
139133
1. If a nested configuration object has been added, add the environment variable option prefix to `getENVPrefix` in [/resources/buildConfigDefinition.js](https://github.com/parse-community/parse-server/blob/master/resources/buildConfigDefinition.js).
140-
1. Execute `npm run definitions` to automatically create the definitions in [/src/Options/Definitions.js](https://github.com/parse-community/parse-server/blob/master/src/Options/Definitions.js).
134+
1. Execute `npm run definitions` to automatically create the definitions in [/src/Options/Definitions.js][config-def] and [/src/Options/docs.js][config-docs].
141135
1. Add parameter value validation in [/src/Config.js](https://github.com/parse-community/parse-server/blob/master/src/Config.js).
142136
1. Add test cases to ensure the correct parameter value validation. Parse Server throws an error at launch if an invalid value is set for any configuration parameter.
137+
1. Execute `npm run docs` to generate the documentation in the `/out` directory. Take a look at the documentation whether the description and formatting of the newly introduced parameters is satisfactory.
143138

144139
## Code of Conduct
145140

0 commit comments

Comments
 (0)