-
Notifications
You must be signed in to change notification settings - Fork 906
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[BUG] Replace documents with prod urls #335
Comments
For this issue, we don't have a replacement document website. We have https://docs-beta.opensearch.org/docs/opensearch-dashboards but it isn't versioned and there is missing documents there. We did the best we can with some replacements that we have. Once we have a permanent replacement then we can complete this issue. |
Will need PROD replacement for the following docs:
|
Replacing previous upstream reference within the edit index pattern page. This does not fully resolve the current issue due to the link being replaced with a temporary link, and the link being related to Mappings API documentation but does not fully replace the content that the original provided. Partially resolves: opensearch-project#482 Will track replacement with: opensearch-project#335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Replacing previous upstream reference within the edit index pattern page. This does not fully resolve the current issue due to the link being replaced with a temporary link, and the link being related to Mappings API documentation but does not fully replace the content that the original provided. Partially resolves: #482 Will track replacement with: #335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Replacing previous upstream reference within the edit index pattern page. This does not fully resolve the current issue due to the link being replaced with a temporary link, and the link being related to Mappings API documentation but does not fully replace the content that the original provided. Partially resolves: #482 Will track replacement with: #335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Replacing previous upstream reference within the edit index pattern page. This does not fully resolve the current issue due to the link being replaced with a temporary link, and the link being related to Mappings API documentation but does not fully replace the content that the original provided. Partially resolves: #482 Will track replacement with: #335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Replacing previous upstream references with working links. This does not fully resolve the current issue due to the link being replaced with a temporary link, and the link directing to related documentation if it exists but some do not so it sends it to the basic OpenSearch Dashboards documentation which is a bad experience but better than a 404. Partially resolves: opensearch-project#335 Will track replacement with: opensearch-project#335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Replacing previous upstream references with working links. This does not fully resolve the current issue due to the link being replaced with a temporary link, and the link directing to related documentation if it exists but some do not so it sends it to the basic OpenSearch Dashboards documentation which is a bad experience but better than a 404. Partially resolves: #335 Will track replacement with: #335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Replacing previous upstream references with working links. This does not fully resolve the current issue due to the link being replaced with a temporary link, and the link directing to related documentation if it exists but some do not so it sends it to the basic OpenSearch Dashboards documentation which is a bad experience but better than a 404. Partially resolves: #335 Will track replacement with: #335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Replacing previous upstream references with working links. This does not fully resolve the current issue due to the link being replaced with a temporary link, and the link directing to related documentation if it exists but some do not so it sends it to the basic OpenSearch Dashboards documentation which is a bad experience but better than a 404. Partially resolves: #335 Will track replacement with: #335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Confirmed with the owners of https://github.com/opensearch-project/documentation-website that the beta site will remain up for the 1.0 GA launch and we can do a follow-up to change the links to point to the production website. |
Duplicate issue: #645 |
A production site for documentation exist at https://opensearch.org/docs/, so we should replace all instances related to https://docs-beta.opensearch.org/. Warning, there are multiple locations where docs-beta was inserted. For example (but not limited to):
Another thing to mention is that the existing production URLs are not versioned. In the future they will need to be. Associated engine issue: opensearch-project/OpenSearch#956 |
Will keep this issue alive but will replace beta with prod url but keeping the references to this issue because we don't have actual replacements for certain links. we just direct users to a default page. |
Updating references to the doc site from docs-beta.opensearch.org to the production site of opensearch.org/docs. Did not remove the TODOs because we do not have replacements for the content yet. Issue partially resolved: opensearch-project#335 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Updating references to the doc site from docs-beta.opensearch.org to the production site of opensearch.org/docs. Did not remove the TODOs because we do not have replacements for the content yet. Issue partially resolved: opensearch-project#335 Backport PR: opensearch-project#733 Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Re-opening, we need replacement docs for documents we removed. |
Doc site is now versioned so will need to handle the code properly in the docs service: example: https://opensearch.org/docs/1.1/dashboards/index/ |
This issue has been repurposed to handle the replacing of the documents with prod urls because we replaced the dead links with the best of our ability but didn't have the best replacements so we replaced to the root document. Even with that there are gaps and even more so they are beta docs so the links aren't final.
Describe the bug
Any hyperlink that sends users to docs fails.
For example:
Flagging link for DQL information doesn't work. e.g. https://www.opensearch.org/guide/en/kibana/main/kuery-query.html navigates to a 404.
To Reproduce
Steps to reproduce the behavior:
Expected behavior
A clear and concise description of what you expected to happen.
OpenSearch Version
1.0.0
Dashboards Version
1.0.0
Plugins
Please list all plugins currently enabled.
Screenshots
If applicable, add screenshots to help explain your problem.
Host/Environment (please complete the following information):
Additional context
Most of the issues we have could be solved by updating this: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/public/doc_links/doc_links_service.ts
The text was updated successfully, but these errors were encountered: