Skip to content
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

Closed
kavilla opened this issue May 7, 2021 · 10 comments · Fixed by #565
Closed

[BUG] Replace documents with prod urls #335

kavilla opened this issue May 7, 2021 · 10 comments · Fixed by #565
Labels
bug Something isn't working docs Improvements or additions to documentation

Comments

@kavilla
Copy link
Member

kavilla commented May 7, 2021

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:

  1. Go to OpenSearch Dashboards
  2. Click on Discover
  3. Click on DQL
  4. Click on link about DQL
  5. See error
    Screen Shot 2021-05-07 at 12 42 30 PM

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):

  • OS: [e.g. iOS]
  • Browser and version [e.g. 22]

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

@kavilla kavilla added the bug Something isn't working label May 7, 2021
@kavilla kavilla changed the title [BUG] Flagging link for DQL information does not work [BUG] External links no longer work May 20, 2021
@kavilla kavilla changed the title [BUG] External links no longer work [BUG] Doc links no longer work May 20, 2021
@ananzh ananzh self-assigned this May 24, 2021
@tmarkley tmarkley assigned tmarkley and unassigned ananzh May 26, 2021
@kavilla kavilla removed the untriaged label May 30, 2021
@kavilla
Copy link
Member Author

kavilla commented May 30, 2021

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.

@kavilla
Copy link
Member Author

kavilla commented Jun 25, 2021

Will need PROD replacement for the following docs:

  • Mappings API documentation
  • Index patterns and adding sample data
  • Date nanos
  • Multimatch DSL query
  • Help menu links for Dashboard, Visualize, Discover
  • Sort Request
  • Maptiles
  • Vegahelp

kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 25, 2021
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>
kavilla added a commit that referenced this issue Jun 26, 2021
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>
kavilla added a commit that referenced this issue Jun 26, 2021
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>
kavilla added a commit that referenced this issue Jun 26, 2021
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>
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Jun 29, 2021
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>
@kavilla kavilla linked a pull request Jun 29, 2021 that will close this issue
5 tasks
kavilla added a commit that referenced this issue Jun 30, 2021
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>
@kavilla kavilla reopened this Jun 30, 2021
@kavilla kavilla changed the title [BUG] Doc links no longer work [BUG] Replace documents with prod urls Jun 30, 2021
kavilla added a commit that referenced this issue Jun 30, 2021
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>
kavilla added a commit that referenced this issue Jun 30, 2021
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>
@tmarkley tmarkley removed the Beta label Jul 12, 2021
@tmarkley
Copy link
Contributor

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.

@tmarkley tmarkley added the docs Improvements or additions to documentation label Jul 12, 2021
@kavilla
Copy link
Member Author

kavilla commented Jul 19, 2021

Duplicate issue: #645

@kavilla
Copy link
Member Author

kavilla commented Jul 19, 2021

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
Associated engine PR: opensearch-project/OpenSearch#957

@kavilla
Copy link
Member Author

kavilla commented Jul 19, 2021

Referenced in #645

Please get link-checker in! It would have immediately flagged these.

Sounds good, created an issue here: #646

@kavilla
Copy link
Member Author

kavilla commented Aug 24, 2021

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.

kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Aug 24, 2021
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>
kavilla added a commit to kavilla/OpenSearch-Dashboards-1 that referenced this issue Aug 27, 2021
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>
@kavilla
Copy link
Member Author

kavilla commented Aug 27, 2021

Re-opening, we need replacement docs for documents we removed.

@kavilla kavilla reopened this Aug 27, 2021
@kavilla kavilla added v1.2.0 and removed v1.1.0 labels Aug 27, 2021
kavilla added a commit that referenced this issue Aug 30, 2021
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:
#335

Backport PR:
#733

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
@kavilla
Copy link
Member Author

kavilla commented Oct 21, 2021

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/

@tmarkley tmarkley added v1.3.0 and removed v1.2.0 labels Oct 26, 2021
@tmarkley tmarkley removed the v1.3.0 label Jan 4, 2022
@tmarkley
Copy link
Contributor

tmarkley commented Jan 4, 2022

Addressed with #905 and #938. Will open a separate issue to track gaps in documentation.

@tmarkley tmarkley closed this as completed Jan 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants