Skip to content

Commit 636b9bb

Browse files
authored
Promote headings in general arch guide (elastic#130816)
Everything was a subheading of `REST and Transport Layers` but most of these things should be sibling headings. This commit brings the incorrectly-nested headings up a level to fix the document structure. Relates ES-9874
1 parent 8ba2ea9 commit 636b9bb

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/internal/GeneralArchitectureGuide.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -182,12 +182,12 @@ capabilities.
182182

183183
## Serializations
184184

185-
## Settings
185+
# Settings
186186

187187
Elasticsearch supports [cluster-level settings][] and [index-level settings][], configurable via [node-level file settings][]
188188
(e.g. `elasticsearch.yml` file), command line arguments and REST APIs.
189189

190-
### Declaring a Setting
190+
## Declaring a Setting
191191

192192
[cluster-level settings]: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html
193193
[index-level settings]: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html
@@ -222,7 +222,7 @@ settings.
222222
[SettingsModule constructor]: https://github.com/elastic/elasticsearch/blob/v8.13.2/server/src/main/java/org/elasticsearch/node/NodeConstruction.java#L491-L495
223223
[getSettings()]: https://github.com/elastic/elasticsearch/blob/v8.13.2/server/src/main/java/org/elasticsearch/plugins/Plugin.java#L203-L208
224224

225-
### Dynamically updating a Setting
225+
## Dynamically updating a Setting
226226

227227
Externally, [TransportClusterUpdateSettingsAction][] and [TransportUpdateSettingsAction][] (and the corresponding REST endpoints)
228228
allow users to dynamically change cluster and index settings, respectively. Internally, `AbstractScopedSettings` (parent class
@@ -244,9 +244,9 @@ state must ever be reloaded from persisted state.
244244
[Metadata]: https://github.com/elastic/elasticsearch/blob/v8.13.2/server/src/main/java/org/elasticsearch/cluster/metadata/Metadata.java#L212-L213
245245
[applied here]: https://github.com/elastic/elasticsearch/blob/v8.13.2/server/src/main/java/org/elasticsearch/cluster/metadata/Metadata.java#L2437
246246

247-
## Deprecations
247+
# Deprecations
248248

249-
## Backwards Compatibility
249+
# Backwards Compatibility
250250

251251
major releases are mostly about breaking compatibility and dropping deprecated functionality.
252252

@@ -292,18 +292,18 @@ See the [public upgrade docs][] for the upgrade process.
292292

293293
[public upgrade docs]: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html
294294

295-
## Plugins
295+
# Plugins
296296

297297
(what warrants a plugin?)
298298

299299
(what plugins do we have?)
300300

301-
## Testing
301+
# Testing
302302

303303
(Overview of our testing frameworks. Discuss base test classes.)
304304

305-
### Unit Testing
305+
## Unit Testing
306306

307-
### REST Testing
307+
## REST Testing
308308

309-
### Integration Testing
309+
## Integration Testing

0 commit comments

Comments
 (0)