1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-12-09 20:04:11 +01:00
Commit Graph

14 Commits

Author SHA1 Message Date
melindafekete
7f3e0d0eb9
remove unnecessary slugs 2025-11-24 18:08:35 +01:00
melindafekete
bf8110c49b
update language-specific guides 2025-11-24 17:34:10 +01:00
melindafekete
8283443523
Move use case guides 2025-11-24 15:16:41 +01:00
melindafekete
528f31f886
update get started 2025-11-24 14:12:50 +01:00
melindafekete
9edf35dd57
Move privary and compliance pages 2025-11-24 11:21:43 +01:00
melindafekete
d29f3b3d6b
update deploy, how-to, and single sign-on 2025-11-19 18:21:10 +01:00
melindafekete
9a99e2e445
Move how-to guides to guides 2025-11-19 16:09:53 +01:00
melindafekete
de3a18235a
Fix link in footer, add redirects 2025-11-18 16:07:44 +01:00
melindafekete
a40b97d068
Rename topics 2025-11-18 15:25:43 +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
68cec1349b
Fix broken doc links (#2046)
## What

This PR fixes some broken links that have been hanging around in the
docs for what seems like a very long time.

## Why

As discovered by the link check in #1912, there are a fair few broken
links in the docs. Everyone hates broken links because it makes it
harder to understand what they were supposed to be pointing at.

## How

There are 3 types of links that have been fixed:
- Links that should have been internal but were absolute. E.g.
  `https://docs.getunleash.io/path/article` that should have been
  `./article.md`
- External links that have changed, such as Slack's API description
- GitHub links to files that either no longer exist or that have been
  moved. These links generally pointed to `master`/`main`, meaning
  they are subject to change. They have been replaced with permalinks
  pointing to specific commits.

-----

* docs: fix slack api doc link

* docs: update links in migration guide

* docs: fix broken link to ancient feature schema validation

* docs: update links to v3 auth hooks

* docs: update broken link in the go sdk article

* Fix: use permalink for GitHub link

* docs: fix wrong google auth link
2022-09-07 14:26:23 +02:00
Thomas Heartman
8b2d02ee5f chore: update deprecation notice. 2022-04-22 11:20:30 +02:00
Thomas Heartman
f1c243fabf docs: Add deprecation notice to old slack guide 2022-04-22 11:16:42 +02:00
Ivar Conradi Østhus
ffec4f6342 fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00