Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摑(website) document the frontend build for dependents #887

Merged
merged 1 commit into from Nov 12, 2019

Conversation

mbenadda
Copy link
Contributor

@mbenadda mbenadda commented Nov 7, 2019

Purpose

Dependents can run their own build for CSS & JS to theme, modify or extend Richie. This was mostly not documented, be it in the repository or in the NPM package that we publish to facilitate it.

We wrote some docs to help users figure out own to run it. They also explain the settings for the JS build.

Note: this does not explain how to actually use the files when they are built, as I don't know how to do that 馃槄
Someone more qualified proabably needs to step in to complete this introduction

@mbenadda mbenadda added needs review needs help docs website Tasks related to the documentation website. labels Nov 7, 2019
@mbenadda mbenadda self-assigned this Nov 7, 2019
docs/building-the-frontend.md Outdated Show resolved Hide resolved
docs/building-the-frontend.md Outdated Show resolved Hide resolved
docs/building-the-frontend.md Outdated Show resolved Hide resolved
@@ -5,7 +5,7 @@
"docker-development",
"native-installation"
],
"Recipes": ["django-react-interop"],
"Recipes": ["django-react-interop", "building-the-frontend"],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should maybe start a multi-line array ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's prettier's job 馃槆

Copy link
Member

@lunika lunika Nov 12, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure the CI runs prettier in the website directory.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, and we should probably add it. I was just saying in this instance I formatted with prettier and it does not put a newline here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done #893

docs/building-the-frontend.md Outdated Show resolved Hide resolved
Dependents can run their own build for CSS & JS to theme, modify
or extend Richie. This was mostly not documented, be it in the
repository or in the NPM package that we publish to facilitate it.

We wrote some docs to help users figure out own to run it. They also
explain the settings for the JS build.
@mbenadda mbenadda merged commit 726f9c1 into master Nov 12, 2019
@mbenadda mbenadda deleted the document-client-build branch November 12, 2019 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs website Tasks related to the documentation website. needs help needs review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants