-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[github.com/transloadit/uppy](https://github.com/transloadit/uppy). | |
[transloadit/uppy](https://github.com/transloadit/uppy). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the previous sentence was clearer. Can you explain what you don't like about it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.