Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Conversation

Simran-B
Copy link
Collaborator

@Simran-B Simran-B commented Sep 20, 2019

This PR adds scripts/fetchRefs.sh, a reworked version of the script we used to sync external repository docs into the main repo, but it can now be run in the docs repo (e.g. using Git Bash):

cd scripts ./fetchRefs.sh git 

It also modifies the migration script to replace https://www.arangodb.com/docs/stable/... links by relative links. There are some flaws however, e.g. the following incorrect conversion (arangojs docs/Drivers/JS/GettingStarted/README.md):

  • Source: [_errorNum_ error code](https://www.arangodb.com/docs/stable/appendix-error-codes.html)
  • Wrong: [_errorNum_ error code](../appendix/error-codes.html)
  • Correct: [_errorNum_ error code](../appendix-error-codes.html)

The unstaged changes need to be compared manually, and only real and correct updates need to be staged. This will hopefully change in the future.

Related: #143

Notes:

  • local .html links won't work on GitHub...
    • docs.arangodb.com link logic needs to be applied to www.arangodb.com/docs as well, to turn absolute into relative links
    • convert relative to absolute links in external repos if they point to main docs
  • descriptions: multiple lines need to be joined with a space
@Simran-B Simran-B added the 9 WIP label Sep 20, 2019
@Simran-B Simran-B self-assigned this Sep 20, 2019
@Simran-B Simran-B removed the 9 WIP label Nov 7, 2019
@Simran-B Simran-B merged commit 2dcf28b into master Nov 7, 2019
@Simran-B Simran-B deleted the migrate-drivers branch November 7, 2019 13:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

1 participant