Fix minor nits in migration README #1131
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
sa-bpelakh
commented
Jul 16, 2024
sa-bpelakh
commented
- Make sure preformatted blocks properly render in HTML
- Properly patch local and relative documentation links in the README
rjyounes
requested changes
Jul 18, 2024
migration/v13.0/README.md
Outdated
| @@ -3,7 +3,7 @@ | |||
| This file gives a quick overview of using the migration utilities provided | |||
| by the gist team to help migrate from the previous version of gist. | |||
|
|
|||
| > See also additional documentation in the file `../../docs/MajorVersionMigration.md`. | |||
| > See also additional documentation in the [Major Version Migration](docs/MajorVersionMigration.md). | |||
There was a problem hiding this comment.
@sa-bpelakh doesn't the link need to be relative to the current directory? See the link at the top of /migration/v13.0/AddressMigration.md to the document in the docs directory:
gist 13.0.0 introduces a new model of physical and electronic addresses (see [full documentation of the model](../../docs/models/AddressGuidance.md)).
This was tested and works.
migration/v13.0/README.md
Outdated
| @@ -124,7 +126,7 @@ onto_tool bundle -v user <USER> -v password <PWD> | |||
| - replaceAddressClasses replaces `gist:EmailAddress` with `gist:ElectronicAddress` | |||
| - replaceAddressClasses replaces `gist:StreetAddress` with `gist:PhysicalAddress` | |||
|
|
|||
| The different types and uses of addresses can be modeled as categories; see [the address migration documentation(AddressMigration.md) as well as the [full documentation of the new address model](/docs/model_documentation/AddressGuidance.md). | |||
| The different types and uses of addresses can be modeled as categories; see [the address migration documentation](./AddressMigration.md) as well as the [full documentation of the new address model](docs/models/AddressGuidance.md). | |||
There was a problem hiding this comment.
Again, this link is not going to work in the repo.
There was a problem hiding this comment.
Two links are still not working ...
major version migration
full documentation ...
rjyounes
reviewed
Jul 19, 2024
rjyounes
reviewed
Jul 19, 2024
rjyounes
approved these changes
Jul 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.