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.
Problem
We currently require users to specify a
repoRootPath
option ingatsby-config.js
in order to generate GitHub edit links for each page.repoRootPath
is the absolute path to the root of the users git repository. Since the path needs to be absolute, users have to use Node.js functions likeprocess.cwd()
andpath.resolve()
to compute the path. This can be confusing for less technical users.Solution
I simplified
repoRootPath
so it now accepts a relative path instead of an absolute path. I also set the defaultrepoRootPath
to'.'
.repoRootPath
can accept a relative path because the current working directory when executinggatsby-node.js
is the root of the user's Gatsby site. So we can useprocess.cwd()
andpath.resolve()
ingatsby-node.js
to compute the absolute path to the root of their git repository given a relative path.Impact
If a user's site is located at the root of their git repository, they won't have to specify
repoRootPath
. If their site is in a subdirectory, they can specify the relative path to the root with a string instead of usingprocess.cwd()
andpath.resolve()
.