1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
Commit Graph

190 Commits

Author SHA1 Message Date
Egor Stronhin
d716175b47
Update README.md (#2620)
Added clear instructions for a quick start with proxy.
2022-12-09 11:48:29 +01:00
Thomas Heartman
d5fbd0b743
refactor: move docs into new structure / fix links for SEO (#2416)
## What

This (admittedly massive) PR updates the "physical" documentation
structure and fixes url inconsistencies and SEO problems reported by
marketing. The main points are:

- remove or move directories : advanced, user_guide, deploy, api
- move the files contained within to the appropriate one of topics,
how-to, tutorials, or reference
- update internal doc links and product links to the content
- create client-side redirects for all the urls that have changed.

A number of the files have been renamed in small ways to better match
their url and to make them easier to find. Additionally, the top-level
api directory has been moved to /reference/api/legacy/unleash (see the
discussion points section for more on this).

## Why

When moving our doc structure to diataxis a while back, we left the
"physical' files lying where they were, because it didn't matter much to
the new structure. However, that did introduce some inconsistencies with
where you place docs and how we organize them.

There's also the discrepancies in whether urls us underscores or hyphens
(which isn't necessarily the same as their file name), which has been
annoying me for a while, but now has also been raised by marketing as an
issue in terms of SEO.

## Discussion points

The old, hand-written API docs have been moved from /api to
/reference/api/legacy/unleash. There _is_ a /reference/api/unleash
directory, but this is being populated by the OpenAPI plugin, and mixing
those could only cause trouble. However, I'm unsure about putting
/legacy/ in the title, because the API isn't legacy, the docs are. Maybe
we could use another path? Like /old-docs/ or something? I'd appreciate
some input on this.
2022-11-22 09:05:30 +00:00
Thomas Heartman
e30b830305
docs: add link to migration guides (#2135) 2022-10-05 10:12:07 +02:00
Pranshu Khanna
688ca2c53f
Updated Readme with the Constraints Announcement 2022-10-04 14:04:28 +02:00
Nuno Góis
5ba5edcaca
docs: add svelte and vue front-end SDKs (#1760)
* docs: add svelte and vue front-end SDKs

* docs: add solid and react native SDKs as Community SDKs

* fix: reorder community SDKs so that they are sorted alphabetically

* fix: note and table

* fix: note scope, reorder community SDKs alphabetically by tech

* fix: make some text consistent across SDKs

* fix: svelte docs

* Update website/docs/sdks/proxy-svelte.md

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>

* fix: headings

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2022-06-29 12:04:21 +01:00
andreas-unleash
64082440d4
OAS for client-metrics controller (#1739)
* OAS for client-metrics controller

* bug and tests

* update snapshot

* update snapshot

* update snapshot

* bug fix

* fix PR comments

* refactoring re PR comments

* re order routes

* remove grouped-client-metrics-schema.ts

* remove grouped-client-metrics-schema.ts

* updated response

* updated snapshot

* PR comments

* PR comments

* Added tests

* Added tests

* fix

* fix

* fix
2022-06-27 11:17:44 +03:00
Thomas Heartman
6b2696f64c
Docs: make the readme demo image a link (#1687) 2022-06-09 09:44:06 +01:00
Ivar Conradi Østhus
e2442f5a2c
chore: test 2022-05-20 16:36:06 +02:00
Ivar Conradi Østhus
590fa50edc
chore: fix coverage badge 2022-05-20 11:26:32 +02:00
Thomas Heartman
7d1a5c2012
docs: add "how to run for development" to CONTRIBUTING.md (#1600)
* docs: add "how to run" to CONTRIBUTING.md

* docs: Refer to the how-to run section from getting started

* Update CONTRIBUTING.md

Co-authored-by: sighphyre <liquidwicked64@gmail.com>

Co-authored-by: sighphyre <liquidwicked64@gmail.com>
2022-05-18 10:16:04 +00:00
Thomas Heartman
68bad77a84
docs: Update Unleash architecture diagram (#1549)
* docs: Update Unleash architecture digram

* fix: typo an -> a

* docs(fix): fix img link in readme

* docs: update architecture graph
2022-05-06 11:17:35 +02:00
Thomas Heartman
d68cacf5d5 fix: center contributors svg 2022-04-22 09:10:34 +02:00
Thomas Heartman
37c8cf8caa docs: Add contributors svg with link to /graphs/contributors 2022-04-22 09:08:20 +02:00
Thomas Heartman
4a9b8feb6f
docs(fix): fix link to environments docs 2022-04-19 09:17:45 +02:00
Thomas Heartman
8867860c38 fix(docs): add colon, align and and vs & 2022-04-08 15:17:43 +02:00
Thomas Heartman
dc5b7d1d45
fix: make section specing consistent 2022-04-08 15:16:00 +02:00
Thomas Heartman
61d353de03
docs: add padding between header and buttons 2022-04-08 13:39:44 +02:00
Thomas Heartman
c7875bc9f5
docs:
Add pre-section margin
2022-04-08 13:38:28 +02:00
Thomas Heartman
6573a12fa9 docs: add margin before sections 2022-04-08 13:36:47 +02:00
Thomas Heartman
ea51004914 fix: inconsistent use of colons, wrong image link 2022-04-08 13:32:11 +02:00
Thomas Heartman
46c15764c4 docs: Add section with links to deployment setup docs 2022-04-08 13:25:46 +02:00
Thomas Heartman
0213dbc8dc docs: Update users of Unleash section 2022-04-08 13:19:02 +02:00
Thomas Heartman
b38963e560 fix: remove rogue question mark 2022-04-08 13:14:36 +02:00
Thomas Heartman
b138812da8 docs: Update "want to know more about unleash" 2022-04-08 13:13:51 +02:00
Thomas Heartman
210bb9da22 docs: delete old sections 2022-04-08 12:55:07 +02:00
Thomas Heartman
c7544d4e08 docs: Update SDKs section 2022-04-08 12:53:47 +02:00
Thomas Heartman
2d8812ef28 docs: move and update architecture section 2022-04-08 12:51:08 +02:00
Thomas Heartman
eeead5216a docs: add updated features section 2022-04-08 12:48:18 +02:00
Thomas Heartman
5f3396f709 fix: remove in-text reminder 2022-04-08 11:05:09 +02:00
Thomas Heartman
479eee7904 docs: Update community section 2022-04-08 11:04:43 +02:00
Thomas Heartman
c42089d6d4 docs: Add online demo illustration image. 2022-04-08 11:02:32 +02:00
Thomas Heartman
78098578a2 docs: add placeholder for online demo; start community section 2022-04-07 16:01:26 +02:00
Thomas Heartman
e6943dddf7 docs: add links for git and docker 2022-04-07 15:53:04 +02:00
Thomas Heartman
602fce8189 fix: header order and sizes 2022-04-07 15:41:49 +02:00
Thomas Heartman
9042263d2f docs: move heroku / DO buttons 2022-04-07 15:40:26 +02:00
Thomas Heartman
83c9125f27 chore: add new header 2022-04-07 15:40:21 +02:00
Thomas Heartman
95c243fa78 chore: fix readme buttons 2022-04-07 15:32:29 +02:00
Thomas Heartman
0c1698cef8 docs: Add client API example. 2022-04-07 15:26:04 +02:00
Thomas Heartman
07408bba45 docs: Add "about unleash section" 2022-04-07 15:22:08 +02:00
Thomas Heartman
188f44dfa5
fix: add alternate (shorter) build badge 2022-04-06 11:43:12 +02:00
Thomas Heartman
004e28aded
fix: build badge link 2022-04-06 11:27:02 +02:00
Thomas Heartman
c58f6cf036 chore: add link to ci build from readme 2022-04-06 11:18:05 +02:00
Thomas Heartman
cde34e70e7 chore: adjust heading levels 2022-04-06 10:48:51 +02:00
Thomas Heartman
c769e2190a chore: move community and contribute sections 2022-04-06 10:24:20 +02:00
Thomas Heartman
ce01c7da3f docs: add get started in 2 steps 2022-04-06 10:23:33 +02:00
Thomas Heartman
23826a3a65 chore: swap twitter and slack buttons 2022-04-06 10:22:16 +02:00
Thomas Heartman
6a01539af0 chore: add slack join badge 2022-04-06 09:31:54 +02:00
Thomas Heartman
f22f16eca2 fix(readme): remove mention of Rust as community SDK 2022-04-05 16:10:35 +02:00
Thomas Heartman
d0506a24da docs: fix heading level in readme 2022-04-05 12:56:54 +02:00
Fredrik Oseberg
28599d32fc fix: readme.md 2022-01-27 16:56:15 +01:00