docs: Make README a quickstart and move concept/benchmarking/deploying to separate files #475
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Manifest Files |
| @@ -3,7 +3,7 @@ | |||
| [](https://crates.io/crates/unleash-edge) | |||
| [](https://docs.rs/unleash-edge/latest) | |||
|  | |||
| [](https://deps.rs/crate/unleash-edge/19.1.3) | |||
| [](https://deps.rs/crate/unleash-edge/19.2.0) | |||
There was a problem hiding this comment.
Is this something we need to manually update every time? If so, can we update <mostrecentversion> in our quickstart command below to be the latest version as well?
Ideally we would be able to automate both.
There was a problem hiding this comment.
yes, Ideally we'd like to update this before cutting releases, that way the dependency banner matches the version it belongs to, rather than whenever we remembered to update it last.
I'd love to find a way to update this automatically based on most recent version.
| @@ -0,0 +1,68 @@ | |||
| # Benchmarking | |||
|
|
|||
| ## Performance | |||
There was a problem hiding this comment.
Probably. But I'm going to have another go at benchmarking now that we have better numbers for small/medium/large feature sets.
There was a problem hiding this comment.
So, I'll leave it in place for this one.
|
|
||
| ## Development | ||
|
|
||
| See our [Contributors guide](./CONTRIBUTING.md) as well as our [development-guide](./development-guide.md) | ||
| See our [Contributors guide](../CONTRIBUTING.md) as well as our [development-guide](../development-guide.md) |
There was a problem hiding this comment.
Just curious: Is server/README.md a duplicate of the root README.md? Why?
There was a problem hiding this comment.
So, due to how we setup the workspace, it's server/README.md that gets published to crates.io, but README.md that is available on github/unleash docs.
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
Co-authored-by: Nuno Góis <github@nunogois.com>
When all edge documentation was in a single page, we had all of it here: https://docs.getunleash.io/reference/unleash-edge but after splitting up Unleash/unleash-edge#475 some of that documentation is not present in our docs and we should probably have them as sub-pages This change allows us to include subpages for external documentation. Note that the key of the subpage needs to match the remote path Checkout the preview: https://unleash-docs-git-add-edge-subpages-unleash-team.vercel.app/  --------- Co-authored-by: Thomas Heartman <thomas@getunleash.io>
Start of the work with regards to making our README the one-stop shop to understand how to run Edge. Moving deployment, concepts, migration and other details into separate files to keep README concise and easy to read.