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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

11 principles page improvements #8704

Merged
merged 4 commits into from
Nov 12, 2024
Merged

Conversation

melindafekete
Copy link
Collaborator

@melindafekete melindafekete commented Nov 8, 2024

Optimize the 11 principles page based on Ercule feedback. Key changes:

  • Reorganize the principles based on heatmap data
  • Add more links
  • Add more screenshots, videos and a table for a visual overview
  • Add additional resources section

Page preview

@melindafekete melindafekete self-assigned this Nov 8, 2024
Copy link

vercel bot commented Nov 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unleash-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 9:47am
unleash-monorepo-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 12, 2024 9:47am

Copy link
Contributor

github-actions bot commented Nov 8, 2024

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Files


Thank you for reading. Our motivation for writing these principles is to share what we've learned building a large-scale feature flag solution with other architects and engineers solving similar challenges. Unleash is open-source, and so are these principles.
Have something to contribute? [Open a PR](https://github.com/Unleash/unleash/pulls) or [discussion](https://github.com/orgs/Unleash/discussions) on our GitHub.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would get rid of everything after this line

I'm not sure we want to give people even more information that they haven't asked for, but we could put a link to our pricing page if they're curious

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It was a suggestion from Ercule to add this section on additional resources: https://docs.google.com/document/d/1aCf0leHvrB9sVjeG3N0icPcUo7y5FcgZz03qX5JvL1Y/edit?tab=t.0

Given it's a page that drives a lot of traffic, I think it makes sense to give people some ideas of where to go next to learn more. The pricing page feels a bit too direct


Avoid using feature flags for static application configuration. Application configuration should be consistent, long-lived, and loaded during application startup. In contrast, feature flags should be short-lived, dynamic, and updated at runtime. They prioritize availability over consistency and can be modified frequently.

<table>
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you prefer an HTML table just for ease of reading?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Well we have lists inside the cells, so it's either markdown + HTML vs pure HTML. I thought the latter was better for readability

Copy link
Contributor

@alvinometric alvinometric left a comment

Choose a reason for hiding this comment

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

Good work updating all the anchors 😄

@ferrantim
Copy link
Collaborator

LGTM, thank you @melindafekete

@melindafekete melindafekete merged commit ce271a6 into main Nov 12, 2024
11 of 12 checks passed
@melindafekete melindafekete deleted the melinda/11-principles-updates branch November 12, 2024 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants