1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Commit Graph

12 Commits

Author SHA1 Message Date
Nuno Góis
6a8ed55c63
feat: better segment info (#3243)
## About the changes

- Updates the segment information on top to be clearer - No longer an
experimental feature, but we do have some limits in place;
- Also updates the documentation to better reflect this;

Co-authored-by: @thomasheartman


![image](https://user-images.githubusercontent.com/14320932/222380864-029e7eef-bcee-4576-b9af-22a591d494a9.png)

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Gastón Fournier <gaston@getunleash.ai>
2023-03-02 14:13:27 +00:00
Thomas Heartman
0b1d4fbd07
docs: add notes to constraints and segment docs about large values (#3142)
## What

This PR adds a note to the constraint and the segment docs about using a
large number of constraint values.

## Why

This is a fairly common question in slack, and there is no clear
documentation around this at the moment. As such, it's likely that
people do this a fair bit without telling us. We don't think this is the
right approach, so adding this bit of documentation should hopefully
make it a little clearer.
2023-02-17 11:06:25 +00: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
7816d8a1f9
Docs: add segments explainer video + fix formatting (#1775) 2022-06-30 08:00:47 +00:00
Thomas Heartman
b3320bf74b
docs: update segments availability notices (#1729)
* docs: change segment availability notice

* docs: update availability note + add some prettier changes

* docs: format imports with prettier
2022-06-22 10:53:24 +02:00
Thomas Heartman
2e1423095e fix: Add missing segments image 2022-04-11 12:17:02 +02:00
Thomas Heartman
d9aae95c26 docs: move when to use segments to top of document 2022-04-04 12:32:47 +02:00
Thomas Heartman
14cb523c91 docs: expand on time-based strategies with segments 2022-04-04 12:16:32 +02:00
Thomas Heartman
971b411db1 docs: explain that with multiple segments, all must be satisfied. 2022-04-04 11:48:59 +02:00
Thomas Heartman
cc670a018c docs: update segments availability: indicate that it's experimental 2022-04-04 11:34:53 +02:00
Thomas Heartman
facf546df4 docs(fix): fix internal links between segments docs 2022-04-02 16:29:45 +02:00
Thomas Heartman
e37714d61a docs: First draft of segments reference doc 2022-04-01 15:47:00 +02:00