eucardano / operations-framework

Building a public non-intrusive transparency framework for communities
GNU General Public License v3.0
4 stars 6 forks source link

Migrate Workspace to independent ECC GitBook org #3

Open ubani opened 10 months ago

ubani commented 9 months ago

@thegrizzly1 how many links for Catalyst are we speaking of - Probably only three - one per milestone, right? Could you extract the original links from the reports so we can create redirects?

As referenced here https://github.com/eucardano/operations-framework/issues/10#issuecomment-1894913174

Will the URLs change if we migrate/sync between two GitBook orgs directly? - 
With the copy the URLs will change. But we need to keep them alive so the community can look them up again.

Also requesting Catalyst's opinion on the migration procedure https://t.me/c/1556514618/7255

We got response today that the original links can be redirected to the new org via a YAML file.

​Redirects

Redirects are commonly used when you are migrating your documentation from one provider to another — like when you just moved your docs to GitBook. Broken links can impact your SEO so we recommend setting up redirects where needed.

Restructuring your content in GitBook

When moving your content within GitBook, most URLs should work as expected depending on complexity of the change. There are a number of tools that will allow you to verify which links were broken, if any.

With Git, when a file is moved many times, the file is removed and a new one is created. This makes it impossible for GitBook to know that a folder has been renamed, for example. Make sure to double-check and add redirects where needed.

How to create a redirect

You can create custom redirects of a URL to a page by specifying the path to the corresponding file. The path is relative to the “root” option. For example, here’s how you can tell GitBook to redirect users accessing a past url /help to a new url /support

.gitbook.yaml

root: ./

redirects:
  help: support.md

How to redirect on a more complex path: Original URL: https://docs.company.com/help which has now moved to https://docs.company.com/misc/support on GitBook.

.gitbook.yaml

root: ./

redirects:
  help: misc/support.md

The path misc/support.md needs to be a real existing path within the repository. It needs to be relative to the current root setting in.gitbook.yaml.

Please don’t add any leading slashes. For example, ./misc/support.md will not work.

Troubleshooting

The YAML file needs to be correctly formatted for the redirects to work. Errors such as incorrect indentation or whitespace can result in your redirects not working. Validating your YAML file can ensure that the redirects will work smoothly.

ubani commented 9 months ago

Waiting on the confirmation of GitBooks community manager before we finally migrate the initial workspace

ubani commented 9 months ago

Migration Status

ubani commented 8 months ago

@thegrizzly1 could you please reference the documentation links here? Then I'll add them to the yaml.