Conversation
explain changes from decaporg/decap-cms#7579
✅ Deploy Preview for decap-www ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Looks good apart from the one minor issue.
There is a more fundamental issue here but it isn’t a new one: this piece of documentation assumes that the repository isn’t a local checkout that needs to be synced up with a remote server. Arguably, modifying the primary repository directly should be an uncommon setup.
It is possible to add a post-commit hook that will automatically push the changes committed by Decap Proxy, yet pulling prior to commit doesn’t seem to be doable with hooks. I had to solve this by modifying my version of Decap Proxy but I’m not sure what a good general solution would look like.
|
Thanks for your review. Updating the local folder is the intended behavior. I also changed the wording because of this. Before, docs said However, we could have a flag that would update the remote repository. |
yanthomasdev
left a comment
There was a problem hiding this comment.
Good work here @martinjagodic, I have a few suggestions.
| --- | ||
| group: Accounts | ||
| weight: 70 | ||
| title: "Decap Proxy: Work With a Local Repository" |
There was a problem hiding this comment.
That's a big title, in documentation subtitles shouldn't appear.
I would probably change it to "Local Backend" (since it is directly related to the setting), what do you think? Note that SEO and search will look into the contents where we specify we are talking about a local folder.
| title: "Decap Proxy: Work With a Local Repository" | |
| title: "Local Backend" |
Alternatively, "Decap Proxy" is better
| title: "Decap Proxy: Work With a Local Repository" | |
| title: "Decap Proxy |
There was a problem hiding this comment.
The feature is actually called "Decap Server", but if this is the title, it can be confusing, as it's only intended for local use. So we could have
- Decap Server for Local Development
- Decap Server (Local Backend)
- Local Development with Decap Server
- ...
There was a problem hiding this comment.
That's generally indicative that the feature name itself could use a rename! With that considered, I guess Local Development fits best.
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Explain changes from decaporg/decap-cms#7579