semaphoreci / semaphore

Semaphore is a Continuous Integration and Delivery platform
https://semaphoreci.com
Apache License 2.0
15 stars 4 forks source link

[Docs]: Add redirections #157

Closed TomFern closed 1 day ago

TomFern commented 3 months ago

Type

Improvement idea

What do you want to report?

Multiple pages on the product have links to the current docs. We need either to update production, or, more likely, add redirections to equivalent pages on the new docs.

We need a list of links from the app going to docs.semaphoreci.com to create the redirections and mappings

Code of Conduct

TomFern commented 2 months ago

Docusaurus has this plugin for redirection: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects

The plugin has thess warnings:

TomFern commented 2 months ago

Docs analytics for docs.semaphoreci.com

https://docs.google.com/spreadsheets/d/1ObkljcFlychxh6N1AU2hW7Pqzp9XyfUBINBznNkqhYs/edit?usp=sharing

We can use this information to:

TomFern commented 2 months ago

These are redirections we must implement. This depends on moving the docs to the root of the Docusaurus site.

Tab: mappings https://docs.google.com/spreadsheets/d/1ObkljcFlychxh6N1AU2hW7Pqzp9XyfUBINBznNkqhYs/edit?gid=1176514415#gid=1176514415

TomFern commented 1 day ago

Redirection rules updated to support trailing slash presence or absence.

TomFern commented 1 day ago

The update broke the Algolia Crawler. There is not much debugging information. The main error:

SafeReindexingError: [v2-sxmoon] Blocking error:
  The difference between the number of records:
    from : 3.68k
    to   : 1
  is too large (100 %), this limit can be modified in the Editor (currently 10 %)

The first row is the new index, the second row is the old (previous to the change). The index is only getting one row after the change:

Image

For some reason the cralwer is not moving past the home page:

Image

After discussing with Alek, we'll try making reverting this lines from:

    location /?$ {
      try_files $uri $uri/index.html $uri/ =404;
    }

to:

 location / {
      try_files $uri $uri/index.html $uri/ =404;
    }

and seeing if that fixes it.

TomFern commented 1 day ago

Update: The change on default.conf fixed the index. Redirections also seems to be working as intended.

Image