Skip to content

Commit

Permalink
Initial draft of the registry developer guide (#38)
Browse files Browse the repository at this point in the history
* initial draft of the registry developer guide

* fix typo

* fix some minor typos

* feat: add first set of registry FAQs

* update brew install command

* fix 2 typos

* Update CLI help output (to be updated once final)

* chore: update deps

* move foundational concepts to its own page, add guide sub-sections, update CLI help outputs

* chore: update deps

* feat: update CLI output, add reference implementations

* proofreading and improving flow

* add manifest file section, add after-push instructions (archive/delete, icon, etc.)

* add curl/brew installation comments and udpate hints

* add beta disclaimers everywhere, add push guided UX, clarify public/private setup

* some typos, add test events sub-section

* rename folder to just registry, update website links

* minor copyediting and fix broken links

* another round of copyediting and minor updates

* Add links to new GitHub repositories in OSS page
  • Loading branch information
alexcasalboni authored Feb 17, 2025
1 parent 906aae0 commit 790cb9b
Show file tree
Hide file tree
Showing 7 changed files with 669 additions and 2 deletions.
13 changes: 13 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,19 @@
"group": "Services",
"pages": [
"services/overview",
{
"group": "Component Registry",
"icon": {
"name": "rectangle-history-circle-plus",
"style": "solid"
},
"pages": [
"services/registry/overview",
"services/registry/foundations",
"services/registry/developer-guide",
"services/registry/faqs"
]
},
{
"group": "Data Collection",
"icon": {
Expand Down
Binary file added images/registry-icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 14 additions & 2 deletions open-source/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Edgee is proud to be 100% open source and we'd love to welcome you to our commun
Check out [our GitHub account](https://github.com/edgee-cloud/) and the main repositories below.


## Edgee Proxy
## Edgee CLI & Edgee Proxy

Edgee's core project is a reverse proxy built in Rust <Icon icon="crab" iconType="solid" />.
Edgee's core project is a CLI and reverse proxy built in Rust <Icon icon="crab" iconType="solid" />.


[<Icon icon="github" iconType="solid" /> /edgee-cloud/edgee](https://github.com/edgee-cloud/edgee)
Expand All @@ -32,6 +32,18 @@ Amplitude: [<Icon icon="github" iconType="solid" /> /edgee-cloud/amplitude-compo

Segment: [<Icon icon="github" iconType="solid" /> /edgee-cloud/segment-component](https://github.com/edgee-cloud/segment-component)

Piano Analytics: [<Icon icon="github" iconType="solid" /> /edgee-cloud/piano-analytics-component](https://github.com/edgee-cloud/piano-analytics-component)

Meta CAPI: [<Icon icon="github" iconType="solid" /> /edgee-cloud/meta-capi-component](https://github.com/edgee-cloud/meta-capi-component)

LinkedIn CAPI: [<Icon icon="github" iconType="solid" /> /edgee-cloud/linkedin-capi-component](https://github.com/edgee-cloud/linkedin-capi-component)

Snapchat CAPI: [<Icon icon="github" iconType="solid" /> /edgee-cloud/snapchat-capi-component](https://github.com/edgee-cloud/snapchat-capi-component)

Pinterest CAPI: [<Icon icon="github" iconType="solid" /> /edgee-cloud/pinterest-capi-component](https://github.com/edgee-cloud/pinterest-capi-component)

Amazon S3: [<Icon icon="github" iconType="solid" /> /edgee-cloud/s3-component](https://github.com/edgee-cloud/s3-component)


## Edgee Documentation

Expand Down
Loading

0 comments on commit 790cb9b

Please sign in to comment.