Commit 37007eb
Refactor Migrations and Upgrades Documentation (opensearch-project#10169)
* Restructured "Is Migration Assistant Right for you?" page.
Signed-off-by: Brian Presley <[email protected]>
* Broke down limitation by component. Minor editorial changes.
Signed-off-by: Brian Presley <[email protected]>
* Removed "Chossing migration approach" since it will be revised and included in a seperate migration patterns page. Updated checklist.
Signed-off-by: Brian Presley <[email protected]>
* Rename Migration Assistant section
Signed-off-by: Archer <[email protected]>
* Fix broken links
Signed-off-by: Archer <[email protected]>
* Add addition upgrade options section
Signed-off-by: Brian Presley <[email protected]>
* Fix home cards page
Signed-off-by: Archer <[email protected]>
* Updated requirements around VPC connectivity.
Signed-off-by: Brian Presley <[email protected]>
* Restructured migration journey and added migration phases.
Signed-off-by: Brian Presley <[email protected]>
* Remove 3.x source support
Signed-off-by: Brian Presley <[email protected]>
* Modifications, fixes, and clarity for migration phases.
Signed-off-by: Brian Presley <[email protected]>
* Moved assets from _migration-upgrade to _migration-assistant
Signed-off-by: Brian Presley <[email protected]>
* Add Migration Assistant to _config.yml
Signed-off-by: Brian Presley <[email protected]>
* Add additional redirects
Signed-off-by: Archer <[email protected]>
* More structure fixes and redirects
Signed-off-by: Archer <[email protected]>
* Fix merge conflict
Signed-off-by: Archer <[email protected]>
* Revered MA card to point to MA, renamed path to migrate-and-upgrade
Signed-off-by: Brian Presley <[email protected]>
* Restructure checkpoint
Signed-off-by: Brian Presley <[email protected]>
* Fixed breadcrumbs. More TOC changes for upgrades and migations. Fixed links. Moved copy.
Signed-off-by: Brian Presley <[email protected]>
* Working structural changes with no broken links
Signed-off-by: Brian Presley <[email protected]>
* Made TOC casing titles consistent and changed the order.
Signed-off-by: Brian Presley <[email protected]>
* Allow symlink to MA without warnings.
Signed-off-by: Brian Presley <[email protected]>
* Updated verbiage for MA zstd limitation
Signed-off-by: Brian Presley <[email protected]>
* Fix breadcrumbs and added redirects for old page paths
Signed-off-by: Brian Presley <[email protected]>
* Updated broken links
Signed-off-by: Brian Presley <[email protected]>
* Update to confirm to style guide
Signed-off-by: Brian Presley <[email protected]>
* Update deploy to reference C&R
Signed-off-by: Brian Presley <[email protected]>
* More convention changes
Signed-off-by: Brian Presley <[email protected]>
* Moved MA back to it's own collection due to framework limitations. Updated navigation behavior
* Add Migration Assistant to primary TOC
* Fix PR review comments: remove duplicate redirects, fix heading hierarchy, and refactor CSS/HTML
- Remove duplicate redirects from snapshots, migrate-or-upgrade, migration-assistant, and rolling-upgrade files
- Add trailing slashes to redirects in rolling-upgrade index for Jekyll convention compliance
- Fix heading hierarchy in rolling-upgrade index (change to level 2 headings)
- Extract inline CSS and HTML from migration-phases into proper Jekyll components:
* Move CSS to _sass/custom/custom.scss
* Create reusable _includes/migration-scenarios.html
* Create _data/migration-scenarios.yml for maintainable data structure
Addresses all review comments from PR opensearch-project#10169
Signed-off-by: Brian Presley <[email protected]>
* Fix example and details formatting
Signed-off-by: Fanit Kolchina <[email protected]>
* Fix broken links
Signed-off-by: Brian Presley <[email protected]>
* Removed code font from header
Signed-off-by: Brian Presley <[email protected]>
* Removed deprecated page and moved the rolling upgrade lab.
Signed-off-by: Brian Presley <[email protected]>
* Fix Vale issues: punctuation, spacing, and terminology consistency
- Added missing comma in rolling upgrade documentation
- Fixed punctuation in home cards description
- Replaced em dash with en dash for consistency
- Fixed 'for example' to 'such as' where appropriate
- Corrected typo 'resoures' to 'resources'
- Removed unnecessary token from rolling upgrade lab
Signed-off-by: Brian Presley <[email protected]>
* Fix Vale issues in migration assistant documentation
- Fixed grammar: 'between version' to 'between versions' in assessment
- Replaced 'e.g.' with 'such as' for consistency
- Improved sentence structure and clarity
Signed-off-by: Brian Presley <[email protected]>
* Fix additional Vale issues in migration assistant documentation
- Replaced 'as well as' with 'and' in verification components
- Changed 'due to' to 'because of' in replay traffic documentation
- Improved consistency with OpenSearch style guide
Signed-off-by: Brian Presley <[email protected]>
* Fix Vale terminology issues: replace 'indices' with 'indexes'
- Changed 'Splitting indices with type mappings' to 'Splitting indexes with type mappings'
- Changed 'Locate the necessary indices and fields' to 'Locate the necessary indexes and fields'
- Maintains consistency with OpenSearch style guide terminology
Signed-off-by: Brian Presley <[email protected]>
* Fix Vale table heading capitalization issues
- Changed table headers to sentence case: 'Lucene version', 'OpenSearch version', 'Elasticsearch version'
- Resolves OpenSearch.TableHeadings Vale rule violations
- Maintains consistency with OpenSearch style guide
Signed-off-by: Brian Presley <[email protected]>
* Fix final Vale issues in migration assistant documentation
- Fixed stacked headings by adding introductory sentence between sections
- Changed 'capture and replay' to 'Capture and Replay' for proper noun capitalization
- Replaced 'abort capabilities' with 'stop capabilities' to avoid offensive terminology
- Resolves OpenSearch.StackedHeadings, Vale.Terms, and OpenSearch.Inclusive rule violations
Signed-off-by: Brian Presley <[email protected]>
* Fix Vale issues in snapshot-restore documentation
- Fixed stacked headings by adding introductory sentence before repository options
- Changed 'Azure Blob Storage' to 'Azure blob storage' for sentence case heading
- Resolves OpenSearch.StackedHeadings and OpenSearch.HeadingCapitalization rule violations
Signed-off-by: Brian Presley <[email protected]>
* Fix Vale directional language issue in assessment documentation
- Changed 'Below is a list of transformations' to 'The following is a list of transformations'
- Resolves OpenSearch.DirectionAboveBelow Vale rule violation
- Improves accessibility and clarity of documentation
Signed-off-by: Brian Presley <[email protected]>
* Fix Vale issues in deploy documentation
- Fixed stacked headings by adding introductory sentence before troubleshooting section
- Changed 'Common Deployment Issues' to 'Common deployment issues' for sentence case heading
- Resolves OpenSearch.StackedHeadings and OpenSearch.HeadingCapitalization rule violations
Signed-off-by: Brian Presley <[email protected]>
* Fixed unecessary .etc.
Signed-off-by: Brian Presley <[email protected]>
* Made Capture-and-Replay references consistent.
Signed-off-by: Brian Presley <[email protected]>
* Small fixes
Signed-off-by: Fanit Kolchina <[email protected]>
* Fix migration-matrix boarder
Signed-off-by: Brian Presley <[email protected]>
* Changed capitalization inconsistencies.
Signed-off-by: Brian Presley <[email protected]>
* Update _migrate-or-upgrade/index.md
Signed-off-by: Nathan Bower <[email protected]>
* Update _migrate-or-upgrade/index.md
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Brian Presley <[email protected]>
* Update _migrate-or-upgrade/index.md
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Brian Presley <[email protected]>
* More editorial changes
Signed-off-by: Brian Presley <[email protected]>
* Submitting changes requested.
Signed-off-by: Brian Presley <[email protected]>
* Update _migrate-or-upgrade/snapshot-restore/index.md
Signed-off-by: Nathan Bower <[email protected]>
* Submitting changes requested.
Signed-off-by: Brian Presley <[email protected]>
* Submitting changes requested.
Signed-off-by: Brian Presley <[email protected]>
* Submitting changes requested.
Signed-off-by: Brian Presley <[email protected]>
* Submitting changes requested.
Signed-off-by: Brian Presley <[email protected]>
* Submitting changes requested.
Signed-off-by: Brian Presley <[email protected]>
* Remove content related to local deployments
Signed-off-by: Brian Presley <[email protected]>
* Fixed javascript breaking changes path
Signed-off-by: Brian Presley <[email protected]>
---------
Signed-off-by: Brian Presley <[email protected]>
Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Nathan Bower <[email protected]>
Signed-off-by: Brian Presley <[email protected]>
Co-authored-by: Brian Presley <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: Brian Presley <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>1 parent bd048f1 commit 37007eb
File tree
53 files changed
+1588
-939
lines changed- .github/vale/styles/Vocab/OpenSearch
- Plugins
- Products
- _api-reference/snapshots
- _benchmark
- _data
- _includes
- _install-and-configure
- configuring-opensearch
- upgrade-opensearch
- appendix
- _layouts
- _migrate-or-upgrade
- migration-assistant
- rolling-upgrade
- snapshot-restore
- _migration-assistant
- deploying-migration-assistant
- migration-console
- migration-phases
- assessment
- deploy
- live-traffic-migration
- migrate-metadata
- planning-your-migration
- overview
- _sass/custom
- _tuning-your-cluster/availability-and-recovery
- remote-store
- snapshots
- assets/js
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
53 files changed
+1588
-939
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
18 | 19 | | |
19 | 20 | | |
20 | 21 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
| 101 | + | |
101 | 102 | | |
102 | 103 | | |
103 | 104 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
16 | | - | |
| 16 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
92 | 95 | | |
93 | 96 | | |
94 | 97 | | |
| |||
142 | 145 | | |
143 | 146 | | |
144 | 147 | | |
145 | | - | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
146 | 152 | | |
147 | 153 | | |
148 | 154 | | |
| |||
218 | 224 | | |
219 | 225 | | |
220 | 226 | | |
221 | | - | |
| 227 | + | |
222 | 228 | | |
223 | 229 | | |
224 | 230 | | |
| |||
265 | 271 | | |
266 | 272 | | |
267 | 273 | | |
268 | | - | |
| 274 | + | |
269 | 275 | | |
270 | 276 | | |
271 | 277 | | |
| |||
352 | 358 | | |
353 | 359 | | |
354 | 360 | | |
355 | | - | |
| 361 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
66 | | - | |
| 66 | + | |
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
71 | 71 | | |
72 | | - | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | | - | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
70 | 91 | | |
71 | 92 | | |
72 | 93 | | |
| |||
89 | 110 | | |
90 | 111 | | |
91 | 112 | | |
92 | | - | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
93 | 129 | | |
94 | 130 | | |
95 | 131 | | |
| |||
112 | 148 | | |
113 | 149 | | |
114 | 150 | | |
115 | | - | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
116 | 167 | | |
117 | 168 | | |
| 169 | + | |
118 | 170 | | |
119 | 171 | | |
120 | 172 | | |
121 | 173 | | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
122 | 191 | | |
123 | 192 | | |
124 | 193 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
8 | 7 | | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| |||
0 commit comments