-
Notifications
You must be signed in to change notification settings - Fork 1k
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
feat(cli): Add README to .redwood #8790
Conversation
We could add this to the create redwood app templates too? If we are happy enough to introduce the overhead of keeping the template files in sync with the template that lives inside the cli package? |
@Josh-Walker-GM It's much more thorough and better than I imagined! Thank you for taking the time to do this. I don't want to miss the original impetus for making sure devs are provided a link to the telemetry page and can control their project's telemetry settings. Were you planning on addressing/adding this somewhere else? And/or what about adding a specific section to the README? @jtoar any additional ideas or reactions? |
Happy to add a specific telemetry section. I'll see what @jtoar thinks about the readme and how best to add a specific telemetry section before I do. With the changes to be "verbose" by default then the only real telemetry option is to disable via the I'm also adding a note which includes a link to the telemetry notice to the telemetry log file inside of Did you, @thedavidprice, want an explicit output to the console that highlights that telemetry is enabled? If so then it's just a question of how often, only once ever or once per 24 hours? |
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.
@Josh-Walker-GM nice, mainly just some typo fixes
^^ Let's do it, how about:
^^ 👍
^^ 👍
^^ Nope! No need given this implementation and improved transparency + communication |
@Josh-Walker-GM Rethinking the implementation of this (hat tip to Tobbe) — I know I wanted to find a way for this README to persist for the case of cloning and git clean. Instead of continually fs.exists and creating, there's a simpler way (maybe):
That's much better and covers my requirements for the most part, does it not? (note: I'm aware this won't apply to existing projects — I'm ok with that as we'll need to call out the updated telemetry in the release notes for v6 and we can mention the web link there.) What say you? |
@thedavidprice I'm fine with the change and will update accordingly. |
Updates the text fixture rebuild script to keep the .redwood/README.md
Based on discussion with @thedavidprice about including a README to explain .redwood **Changes** 1. Adds a template for a readme file that describes what .redwood is and what it contains. 2. Adds a check that fires on every CLI command to check that this new readme exists. @jtoar Would you mind reviewing this. I think you tend to be the documentation guy and I might not have the same voice as is typical. @thedavidprice anything missing here to what you envisioned?
Based on discussion with @thedavidprice about including a README to explain .redwood
Changes
@jtoar Would you mind reviewing this. I think you tend to be the documentation guy and I might not have the same voice as is typical. @thedavidprice anything missing here to what you envisioned?