docs: 📝 Update Bundle parameter syntax #230
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
7 tasks
gabrielmpinto
approved these changes
Sep 19, 2024
heldrida
added a commit
to fleek-platform/cli
that referenced
this pull request
Sep 19, 2024
## Why? Most parameters take a value. The bundle parameter is optional but shouldn't be a negation. It's confusing and counter-intuitive. Rather, have the bundle parameter that defaults to true, e.g. defaults to bundling. If the user wants to prevent bundling, it'd have to set the bundle parameter to false, which is a similar flow as for other parameters, e.g. name.⚠️ Related to fleek-platform/website#230 ## How? - Replace the term in the types - Replace the term in the command generator - Create localized text ## Tickets? - [PLAT-1273](https://linear.app/fleekxyz/issue/PLAT-1273/the-bundle-parameter-is-not-intuitive-due-to-negation-eg-nobundle) ## Contribution checklist? - [x] The commit messages are detailed - [x] The `build` command runs locally - [ ] Assets or static content are linked and stored in the project - [ ] You have manually tested - [ ] You have provided tests ## Security checklist? - [ ] Sensitive data has been identified and is being protected properly - [ ] Injection has been prevented (parameterized queries, no eval or system calls) ## Preview? > Bundle is Enabled by default <img width="809" alt="Screenshot 2024-09-19 at 14 13 44" src="https://github.com/user-attachments/assets/d064d4c8-0fdc-4c57-a3e5-4826e952b8ea"> > Bundle is Disabled if user sets it as false <img width="811" alt="Screenshot 2024-09-19 at 14 14 05" src="https://github.com/user-attachments/assets/093b07f5-8593-4d1d-8c33-fd32120d61fe">
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why?
The bundle parameter has changed in fleek-platform/cli#34, thus the documentation has to reflect the changes.
How?
Tickets?
Contribution checklist?
buildcommand runs locallySecurity checklist?
References?
Optionally, provide references such as links
Preview?
Optionally, provide the preview url here