docs: Homepage and Getting Started section #5772
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
|
@guiwrite is attempting to deploy a commit to the Flagsmith Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
I've added a few specific comments, but I want to also provide some general feedback that might be relevant to the rest of the PRs as I go through them:
- Consistency of capitalisation. Unless a term is a proper noun, we shouldn't capitalise it. I have seen instances where feature, flag, organisation, project, etc. have all been capitalised, and other instance where they are not capitalised. Let's stick to not capitalising.
- Identities are not necessarily users. Please try to avoid indicating that identities are users. In a lot of cases they probably are, but they don't have to be - they can be a device, a tenant, a server, etc. - it's why they're called identities, not users.
Also, related to the PR itself, please make sure that you're following conventional commit guidelines with the title of your PRs - I've updated the title of this one, but please keep in mind for future PRs.
|
|
||
| 4. Because your button only shows when the "sharing_button" flag is set to True, you are safe to commit your code as you work on the feature. Your code will be live within the production platform, but the functionality is hidden behind the flag. | ||
|
|
||
| 5. Once you are happy with your Feature, you can enable the "sharing_button" for other members of your team and with beta testers. |
There was a problem hiding this comment.
Please make sure that we're consistent with capitalisation.
| 5. Once you are happy with your Feature, you can enable the "sharing_button" for other members of your team and with beta testers. | |
| 5. Once you are happy with your feature, you can enable the "sharing_button" for other members of your team and with beta testers. |
There was a problem hiding this comment.
It looks like this is an issue throughout this page. I can see instances where the term 'feature flag' is in title case, and others where it's not. My opinion is that we shouldn't capitalise anything that's not a proper noun. Please can you go through this PR (and others) and make sure that we're consistent with the usage of feature flags (lower case).
There was a problem hiding this comment.
@guiwrite I can still see quite a few inconsistencies, particularly around the term 'feature flag' - can you make sure that it's lower case everywhere?
matthewelwell
changed the title
Co-authored-by: Matthew Elwell <mjelwell89@gmail.com>
Thanks for submitting a PR! Please check the boxes below:
docs/if required so people know about the feature!Changes
How did you test this code?
No changes to the code, only to the docs.