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

8 Commits

Author SHA1 Message Date
Thomas Heartman
9c7eadded0
docs: switch order of api doc sidebar items; put legacy docs under legacy header (#4135)
Also adds a caution admonition to the legacy doc index page
2023-07-04 14:19:34 +02:00
Gastón Fournier
13def9a3a3
docs: Documentation around metrics API (#4134)
## About the changes
Mark some legacy endpoints as deprecated (they are long deprecated but
documentation was out of date) and fix some of the URLs
2023-07-04 11:16:05 +02:00
Thomas Heartman
b815fa1a9d
docs: add migration guide entry for v4 -> v5 (#3650)
This lists the breaking changes between the versions to make it easier
(and safer) for users to upgrade
2023-04-28 13:10:30 +02:00
Christopher Kolstad
1fdf68eeec
task: removes deprecated feature api (#3609)
### What
We've had this marked as deprecated through our v4, this PR removes it.

### Worth noting
This updates the deprecation notices with removal notices in the
documentation as well.

### Considerations
The tags API is still located under
/api/admin/features/{featureName}/tags. It should be moved to
/api/admin/projects/{project}/features/{featureName}/tags. I vote we do
that in a separate PR, we'd probably also need to deprecate the existing
tags endpoints for v5 and remove in v6. We could use 308s to signify
that they are moved.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-04-26 10:45:00 +02:00
Gastón Fournier
29907d8d9f
doc: update link to new import/export (#3584)
## About the changes
Add correct link to new import/export
2023-04-21 08:49:05 +00:00
Gastón Fournier
b593bdd404
docs: deprecation notice on state api (#3561)
## About the changes
Update documentation about the deprecation of state API.

Related to https://github.com/Unleash/unleash/issues/1265
2023-04-21 09:19:22 +02:00
Gastón Fournier
291bcb4a0f
docs: new variants per environment (#2590)
## About the changes
Documentation about feature toggle variants per environment

## Discussion points
The version when this will be available is still to be defined.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-02-24 15:25:03 +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