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

18 Commits

Author SHA1 Message Date
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
8916de76be
docs: Remove/update references to Heroku (#2099)
## What

This PR removes or updates references in the docs to Heroku. Most of the code samples have been replaced with a more generic `unleash.example.com` url, while other references have been removed or updated.

Also removes old OpenAPI files that are out of date and redundant with the new generation.

## Background

Come November and Heroku will no longer offer free deployments of Unleash, so it's about time we remove that claim.

Links to the heroku instance are also outdated because we don't have that instance running anymore.

Finally, the OpenAPI files we do have there are old and static, so they don't match the current reality.

## Commits

* Meta: update ignore file to ignore autogenerated docs

I must've missed the ignore file when looking for patterns.

* docs: delete old openapi file.

This seems to have been a holdover from 2020 and is probably
hand-written. It has been superseded by the new autogenerated OpenAPI docs.

* docs: add notes for heroku changes to the frontend readme and pkg

* docs: remove old openapi article and add redirects to new openapi

* docs: fix link in overview doc: point to GitHub instead of heroku

* docs: update quickstart docs with new heroku details

* docs: remove reference to crashing heroku instance

* docs: remove references to herokuapp in  code samples

* docs: add a placeholder comment

* docs: update references for heroku updates

* docs: keep using unleash4 for enterprise

* docs: remove start:heroku script in favor of start:sandbox

* docs: remove 'deploy on heroku button'

Now that it's not free anymore (or won't be very shortly), let's
remove it.

* docs: remove extra newline
2022-10-19 12:02:00 +00:00
Thomas Heartman
b06cbb0f75
docs: remove references to deprecated proxy config variable (#1902) 2022-08-09 16:20:28 +02:00
Thomas Heartman
be3452e36f
Merge pull request #1221 from Unleash/docs/add-npm2yarn
docs: add `npm2yarn` annotation to all npm commands
2022-01-04 14:00:43 +01:00
Thomas Heartman
1241827b6a docs(chore): remove spacing, change 'node' -> Node.js 2022-01-04 10:19:32 +01:00
Thomas Heartman
7444b2cb74 docs(chore): add npm2yarn annotation to all npm commands 2022-01-04 10:18:13 +01:00
Thomas Heartman
0344dc79e4 docs(typo): pluralize SDK -> SDKs 2022-01-03 14:42:59 +01:00
Thomas Heartman
5a30706150 docs(fix): fix comparison operator from > to < 2022-01-03 13:08:25 +01:00
Thomas Heartman
dd975ec344 docs: highlight customStrategies option. 2022-01-03 10:26:29 +01:00
Thomas Heartman
bdbd659a71 docs(chore): indent code block properly. 2022-01-03 10:19:04 +01:00
Thomas Heartman
8ae2de8a3e docs: add steps for running the proxy in node with custom strats. 2022-01-03 10:12:13 +01:00
Thomas Heartman
b83a45fc59 fix(docs): realign indentation of code and comments
Seems something went wrong the last time 🤷
2021-12-22 14:21:04 +01:00
Thomas Heartman
120345953a fix(docs): align code and highlight indentation. 2021-12-22 14:20:07 +01:00
Thomas Heartman
2b08b6f67b docs(strats): describe using custom strats when proxy is not docker. 2021-12-22 13:24:22 +01:00
Thomas Heartman
30c6e7c0af docs(custom strats): add steps for custom strats with proxy. 2021-12-22 12:37:40 +01:00
Thomas Heartman
d60dcfa9d4 docs(strats): start filling in how-to for custom strats 2021-12-22 11:36:08 +01:00
Thomas Heartman
adc429c90c docs(strats): semi-scaffold how-to section 2021-12-22 09:59:35 +01:00
Thomas Heartman
9791783be5 docs(strats): separate reference and how-to 2021-12-22 09:59:32 +01:00