Building uppy.io/docs VS uppy.io/blog #243
Conversation
| static website generator. | ||
| Code for [uppy.io/blog](https://uppy.io/blog) lives in this repo. | ||
| Code for [uppy.io/docs](https://uppy.io/docs/quick-start) lives in | ||
| [github.com/transloadit/uppy](https://github.com/transloadit/uppy). |
There was a problem hiding this comment.
| [github.com/transloadit/uppy](https://github.com/transloadit/uppy). | |
| [transloadit/uppy](https://github.com/transloadit/uppy). |
There was a problem hiding this comment.
Why? I feel github.com prefix makes it more intelligible, and removes the need to remember github-specific shortcuts.
| Now, treat **/uppy/docs** as your working directory, but run the build/lint | ||
| scripts from your **/uppy.io** directory - **/uppy.io** will pick up your | ||
| changes. |
There was a problem hiding this comment.
I don't really understand the "treat as your working directory"
| Now, treat **/uppy/docs** as your working directory, but run the build/lint | |
| scripts from your **/uppy.io** directory - **/uppy.io** will pick up your | |
| changes. | |
| Now, when running the build/lint scripts from the root of your `transloadit/uppy.io` clone, it will pick up your local changes on the `docs/` folder. Note that changes in the `docs/` changes should be submitted to the `transloadit/uppy` repository. |
There was a problem hiding this comment.
"treat /uppy/docs as your working directory" means "/uppy/docs is a folder where you will be editing files, then committing the files, and then pushing the files".
| This command builds **/uppy/docs** and **/uppy.io**, and shows them in a | ||
| browser. Most changes are reflected live without having to restart the server. |
There was a problem hiding this comment.
I think the previous sentence was clearer. Can you explain what you don't like about it?
There was a problem hiding this comment.
I want to make it explicit that both /uppy/docs and /uppy.io will be built using this command.
| corepack yarn lint | ||
| ``` | ||
|
|
||
| This command lints **/uppy/docs** and **/uppy.io**. |
There was a problem hiding this comment.
| This command lints **/uppy/docs** and **/uppy.io**. | |
| N.B.: These commands will also report lint errors from the `docs` folder that's hosted on the `transloadit/uppy` repository. |
There was a problem hiding this comment.
My version is more consistent with the phrasing of other command descriptions.
Co-authored-by: Antoine du Hamel <antoine@transloadit.com>
Added docs about how to lint/build uppy.io/docs as per our Slack discussion.