Fix symlink for server installation documentation in README#393
Open
IanSkelskey wants to merge 1 commit intoevergreen-library-system:mainfrom
Open
Fix symlink for server installation documentation in README#393IanSkelskey wants to merge 1 commit intoevergreen-library-system:mainfrom
IanSkelskey wants to merge 1 commit intoevergreen-library-system:mainfrom
Conversation
Contributor
|
Great that GitHub knows how to render AsciiDoc! There are a couple issues to sort out before this can be merged:
But to be clear, I support the idea. |
Contributor
Author
|
@gmcharlt Sounds good to me. Thanks for the prompt reply! I can work on that between now and the meeting this afternoon. Though my attention is a little split with snow removal (I'm in CT). ☃️ |
IanSkelskey
force-pushed
the
readme-symlink-fix
branch
2 times, most recently
from
1718639 to
b9790dc
Compare
Rename README to README.adoc and update the symlink to the server installation documentation. Signed-off-by: Ian Skelskey ianskelskey@gmail.com
IanSkelskey
force-pushed
the
readme-symlink-fix
branch
from
b9790dc to
e642870
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We discussed this issue in the last GitHub working group meeting. We mentioned possibly making a separate markdown readme, but it looks like changing the format isn't necessary, we just need to tell GitHub what format to render with the symlink, which can be accomplished by adding
.adocto the symlink's name.Currently, the readme isn't displaying correctly on github and looks like this:
After this update, it will render properly with formatting:
You can see it in action on the source branch for this PR:
https://github.com/IanSkelskey/Evergreen/tree/readme-symlink-fix