Skip to content

Commit b6ac7f8

Browse files
opensearch-trigger-bot[bot]github-actions[bot]peterzhuamazon
authored
Prepare for migration from /docs/latest to /latest (#10324) (#10395)
* Prepare for migration from /docs/latest to /latest * Fix hardcoded link * Fix links * One more link fix * Update spec-insert to resolve the checks error --------- (cherry picked from commit 6f86f2b) Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Peter Zhu <zhujiaxi@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Peter Zhu <zhujiaxi@amazon.com>
1 parent eb4d698 commit b6ac7f8

File tree

23 files changed

+45
-50
lines changed

23 files changed

+45
-50
lines changed

.github/vale/styles/OpenSearch/LinksExplicit.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ nonword: true
55
scope: raw
66
tokens:
77
- '\]\(https:\/\/www.opensearch.org\/docs\/latest'
8-
8+
- '\]\(https:\/\/docs.opensearch.org\/docs\/latest'
9+
- '\]\(https:\/\/docs.opensearch.org\/latest'

404.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,5 @@ nav_exclude: true
88

99
## Oops, this isn't the page you're looking for.
1010

11-
Maybe our [home page](https://opensearch.org/docs/latest) or one of the commonly visited pages below will help. If you need further support, please use the feedback feature on the right side of the screen to get in touch.
12-
13-
- [Quickstart]({{site.url}}{{site.baseurl}}/quickstart/)
14-
- [Installing OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/)
15-
- [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/index/)
16-
- [Query DSL]({{site.url}}{{site.baseurl}}/query-dsl/)
17-
- [API Reference]({{site.url}}{{site.baseurl}}/api-reference/index/)
18-
11+
Maybe our [home page](https://docs.opensearch.org/latest/) or one of the commonly visited pages below will help. If you need further support, please use the feedback feature on the right side of the screen to get in touch.
1912

API_STYLE_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Provide an API name that describes its function, followed by a description of it
4848
Use sentence capitalization for the heading (for example, "Create or update mappings"). When you refer to the API operation, you can use lowercase with code font.
4949

5050
If there is a corresponding OpenSearch Dashboards feature, provide a “See also” link that references it.
51-
*Example*: “To learn more about monitor findings, see [Document findings](https://opensearch.org/docs/latest/monitoring-plugins/alerting/monitors/#document-findings)."
51+
*Example*: “To learn more about monitor findings, see [Document findings](https://docs.opensearch.org/latest/monitoring-plugins/alerting/monitors/#document-findings)."
5252

5353
If applicable, provide any caveats to its usage with a note or tip, as in the following example:
5454

DEVELOPER_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
## Introduction
1313

14-
The `.md` documents in this repository are rendered into HTML pages using [Jekyll](https://jekyllrb.com/). These HTML pages are hosted on [opensearch.org](https://opensearch.org/docs/latest/).
14+
The `.md` documents in this repository are rendered into HTML pages using [Jekyll](https://jekyllrb.com/). These HTML pages are hosted on [opensearch.org](https://docs.opensearch.org/latest/).
1515

1616
## Starting the Jekyll server locally
1717

STYLE_GUIDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Use lowercase when referring to features, unless you are referring to a formally
5151

5252
A plugin is a feature or distinct component that extends the functionality of OpenSearch. For now, capitalize plugin names, but use *plugin* sparingly. The concept of plugins will become obsolete once we re-architect the product. For example:
5353

54-
* "Interaction with the *ML Commons* plugin occurs through either the REST API or [ad](https://opensearch.org/docs/latest/search-plugins/sql/ppl/functions#ad) and [kmeans](https://opensearch.org/docs/latest/search-plugins/sql/ppl/functions#kmeans) Piped Processing Language (PPL) commands."
54+
* "Interaction with the *ML Commons* plugin occurs through either the REST API or [ad](https://docs.opensearch.org/latest/search-plugins/sql/ppl/functions#ad) and [kmeans](https://docs.opensearch.org/latest/search-plugins/sql/ppl/functions#kmeans) Piped Processing Language (PPL) commands."
5555
* "Use the *Neural Search* plugin to integrate ML language models into your search workloads."
5656

5757
### Voice and tone
@@ -263,7 +263,7 @@ When introducing a code or command line example that refers to a variable or pla
263263
- Where space is limited (for example, in a table), you can use "*See* [link text]."
264264
- Ensure that the link text matches the section title text. <br> <br> Example: "To get involved, see [Contributing](https://opensearch.org/source.html) on the OpenSearch website." <br>
265265

266-
- **Embedded links**: Embedded links are woven into a sentence without formal introductory text. They're especially useful in tables or other elements where space is tight. The text around the embedded link must relate to the information in the link so that the reader understands the context. Do not use *here* or *click here* for link text because it creates accessibility problems. <br> <br> Example: "Finally, [delete the index](https://opensearch.org/docs/latest/api-reference/index-apis/delete-index)."
266+
- **Embedded links**: Embedded links are woven into a sentence without formal introductory text. They're especially useful in tables or other elements where space is tight. The text around the embedded link must relate to the information in the link so that the reader understands the context. Do not use *here* or *click here* for link text because it creates accessibility problems. <br> <br> Example: "Finally, [delete the index](https://docs.opensearch.org/latest/api-reference/index-apis/delete-index)."
267267

268268
### Lists
269269

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
title: OpenSearch Documentation
22
description: >- # this means to ignore newlines until "baseurl:"
33
Documentation for OpenSearch, the Apache 2.0 search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
4-
baseurl: "/docs/latest" # The subpath of the current version. This is version-specific. For example, for 2.19, the base URL is /docs/2.19.
5-
latesturl: "/docs/latest" # The subpath of the latest version. Used for non-version-specific documentation, like Data Prepper, etc.
4+
baseurl: "/latest" # The subpath of the current version. This is version-specific. For example, for 2.19, the base URL is /docs/2.19.
5+
latesturl: "/latest" # The subpath of the latest version. Used for non-version-specific documentation, like Data Prepper, etc.
66
url: "https://docs.opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com
77
permalink: /:path/
88

_data/migration-assistant/breaking-changes.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,22 @@ breaking_changes:
2222
introducedIn: "OpenSearch 1.x"
2323
comp: []
2424
- title: "OpenSearch 2.x: Remove mapping types parameter"
25-
url: "https://docs.opensearch.org/docs/latest/breaking-changes/#remove-mapping-types-parameter"
25+
url: "https://docs.opensearch.org/latest/breaking-changes/#remove-mapping-types-parameter"
2626
introducedIn: "OpenSearch 2.x"
2727
comp: []
2828
transformation:
2929
title: "Type Mapping Deprecation"
30-
url: "https://docs.opensearch.org/docs/latest/migration-assistant/migration-phases/planning-your-migration/handling-type-mapping-deprecation/"
30+
url: "https://docs.opensearch.org/latest/migration-assistant/migration-phases/planning-your-migration/handling-type-mapping-deprecation/"
3131
- title: "OpenSearch 3.x: Breaking Changes"
32-
url: "/docs/latest/breaking-changes/#300"
32+
url: "https://docs.opensearch.org/latest/breaking-changes/#300"
3333
introducedIn: "OpenSearch 3.x"
3434
comp: []
3535
- title: "OpenSearch Notifications Plugins"
36-
url: "https://docs.opensearch.org/docs/latest/breaking-changes/#add-opensearch-notifications-plugins"
36+
url: "https://docs.opensearch.org/latest/breaking-changes/#add-opensearch-notifications-plugins"
3737
introducedIn: "OpenSearch 2.x"
3838
comp: []
3939
- title: "OpenSearch 2.x: Client JDK 8 Support Dropped"
40-
url: "https://docs.opensearch.org/docs/latest/breaking-changes/#drop-support-for-jdk-8"
40+
url: "https://docs.opensearch.org/latest/breaking-changes/#drop-support-for-jdk-8"
4141
introducedIn: "OpenSearch 2.x"
4242
comp: []
4343
- title: "Removal of Types in Elasticsearch 7.x"
@@ -46,7 +46,7 @@ breaking_changes:
4646
comp: []
4747
transformation:
4848
title: "Type Mapping Deprecation"
49-
url: "https://docs.opensearch.org/docs/latest/migration-assistant/migration-phases/planning-your-migration/handling-type-mapping-deprecation/"
49+
url: "https://docs.opensearch.org/latest/migration-assistant/migration-phases/planning-your-migration/handling-type-mapping-deprecation/"
5050
- title: "Elasticsearch 6.0 - 6.6 Breaking Changes"
5151
url: "https://www.elastic.co/guide/en/elasticsearch/reference/6.8/breaking-changes.html"
5252
introducedIn: "Elasticsearch 6.x"

_data/top_nav.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,18 @@ items:
4040
- label: Members
4141
url: https://opensearch.org/authors-list/
4242
- label: Documentation
43-
url: https://docs.opensearch.org/docs/latest/
43+
url: https://docs.opensearch.org/latest/
4444
children:
4545
- label: OpenSearch and Dashboards
46-
url: https://docs.opensearch.org/docs/latest/about/
46+
url: https://docs.opensearch.org/latest/about/
4747
- label: Data Prepper
48-
url: https://docs.opensearch.org/docs/latest/data-prepper/
48+
url: https://docs.opensearch.org/latest/data-prepper/
4949
- label: Clients
50-
url: https://docs.opensearch.org/docs/latest/clients/
50+
url: https://docs.opensearch.org/latest/clients/
5151
- label: Benchmark
52-
url: https://docs.opensearch.org/docs/latest/benchmark/
52+
url: https://docs.opensearch.org/latest/benchmark/
5353
- label: Migration Assistant
54-
url: https://docs.opensearch.org/docs/latest/migration-assistant/
54+
url: https://docs.opensearch.org/latest/migration-assistant/
5555
- label: Blog
5656
url: https://opensearch.org/blog/
5757
- label: Download

_migration-assistant/overview/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ Each node in the diagram correlates to the following steps in the migration proc
1919
2. An Application Load Balancer with capture proxies relays traffic to a source while replicating data to Amazon Managed Streaming for Apache Kafka (Amazon MSK).
2020
3. Using the migration console, you can initiate metadata migration to establish indexes, templates, component templates, and aliases on the target cluster.
2121
4. With continuous traffic capture in place, you can use a `reindex-from-snapshot` process to capture data from your current index.
22-
5. Once `Reindex-from-Snapshot` is complete, captured traffic is replayed from Amazon MSK to the target cluster by [Traffic Replayer](https://docs.opensearch.org/docs/latest/migration-assistant/migration-phases/live-traffic-migration/using-traffic-replayer/).
22+
5. Once `Reindex-from-Snapshot` is complete, captured traffic is replayed from Amazon MSK to the target cluster by [Traffic Replayer]({{site.url}}{{site.baseurl}}/migration-assistant/migration-phases/live-traffic-migration/using-traffic-replayer/).
2323
6. Performance and behavior of traffic sent to the source and target clusters are compared by reviewing logs and metrics.
2424
7. After confirming that the target cluster's functionality meets expectations, clients are redirected to the new target.

_migration-assistant/overview/key-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This component is designed for HTTP RESTful traffic. It forwards traffic to the
2323

2424
## Traffic Replayer
2525

26-
Acting as a traffic simulation tool, [Traffic Replayer](https://docs.opensearch.org/docs/latest/migration-assistant/migration-phases/live-traffic-migration/using-traffic-replayer/) replays recorded request traffic to a target cluster, mirroring source traffic patterns. It links original requests and their responses to those directed at the target cluster, facilitating comparative analysis.
26+
Acting as a traffic simulation tool, [Traffic Replayer]({{site.url}}{{site.baseurl}}/migration-assistant/migration-phases/live-traffic-migration/using-traffic-replayer/) replays recorded request traffic to a target cluster, mirroring source traffic patterns. It links original requests and their responses to those directed at the target cluster, facilitating comparative analysis.
2727

2828
## Metadata migration tool
2929

0 commit comments

Comments
 (0)