From ea10fceb8c26ea8a5a61138d98adaa87ae0713b7 Mon Sep 17 00:00:00 2001 From: Rushat Gabhane Date: Fri, 7 Jun 2024 17:54:39 +0300 Subject: [PATCH 1/4] add instr to hide an article --- docs/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/README.md b/docs/README.md index 224abe0554a5e..e151bbba49010 100644 --- a/docs/README.md +++ b/docs/README.md @@ -189,6 +189,12 @@ Assume that we want to rename the article `The Free Plan` to `Freemium Features` Note: It is important that the file has `.md` extension. +# How to hide an article temporarily +1. Open github's in built code editor. ([instructions here](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor#opening-the-githubdev-editor)) +2. Go to the article `docs/articles/..` +3. Drag and drop the article to the hidden folder. `docs/Hidden/` +4. Commit the changes and raise a PR + # How the site is deployed This site is hosted on Cloudflare pages. Whenever code is merged to main, the github action `deployExpensifyHelp` will run. From e97b575178a7fac8e951794cf0c7db0e6e0ad635 Mon Sep 17 00:00:00 2001 From: Rushat Gabhane Date: Fri, 7 Jun 2024 18:01:15 +0300 Subject: [PATCH 2/4] Update README.md --- docs/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index e151bbba49010..5d2370f80763e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -190,10 +190,11 @@ Assume that we want to rename the article `The Free Plan` to `Freemium Features` Note: It is important that the file has `.md` extension. # How to hide an article temporarily -1. Open github's in built code editor. ([instructions here](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor#opening-the-githubdev-editor)) +Video demo available [here 🧵](https://expensify.slack.com/archives/C02NK2DQWUX/p1717772272605829?thread_ts=1717523271.137469&cid=C02NK2DQWUX). +1. Open github's in built code editor by pressing `.` on your keyboard. ([instructions here](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor#opening-the-githubdev-editor)) 2. Go to the article `docs/articles/..` 3. Drag and drop the article to the hidden folder. `docs/Hidden/` -4. Commit the changes and raise a PR +4. Commit the changes and raise a PR. # How the site is deployed This site is hosted on Cloudflare pages. Whenever code is merged to main, the github action `deployExpensifyHelp` will run. From 796f8bc1076e7434b85616780e15d47ba2cc54f5 Mon Sep 17 00:00:00 2001 From: Rushat Gabhane Date: Fri, 7 Jun 2024 18:03:02 +0300 Subject: [PATCH 3/4] Update README.md --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 5d2370f80763e..ad580daadd7fe 100644 --- a/docs/README.md +++ b/docs/README.md @@ -192,8 +192,8 @@ Note: It is important that the file has `.md` extension. # How to hide an article temporarily Video demo available [here 🧵](https://expensify.slack.com/archives/C02NK2DQWUX/p1717772272605829?thread_ts=1717523271.137469&cid=C02NK2DQWUX). 1. Open github's in built code editor by pressing `.` on your keyboard. ([instructions here](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor#opening-the-githubdev-editor)) -2. Go to the article `docs/articles/..` -3. Drag and drop the article to the hidden folder. `docs/Hidden/` +2. Go to the article that you want to hide `docs/articles/...`. +3. Drag and drop the article inside the hidden folder `docs/Hidden/`. 4. Commit the changes and raise a PR. # How the site is deployed From c3809383b659a2b894295312a6fa36e61aa97982 Mon Sep 17 00:00:00 2001 From: Rushat Gabhane Date: Fri, 7 Jun 2024 18:07:01 +0300 Subject: [PATCH 4/4] Update README.md --- docs/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index ad580daadd7fe..235334c957326 100644 --- a/docs/README.md +++ b/docs/README.md @@ -186,6 +186,7 @@ Just update the content for each variable accordingly or remove it if the inform Assume that we want to rename the article `The Free Plan` to `Freemium Features` for the hub `billing and plan types` in New Expensify platform. 1. Go to `docs/articles/new-expensify/billing-and-plan-types` 2. Rename `The-Free-Plan.md` to `Freemium-Features.md`. Use dashes for spaces in the file name. +3. Add an entry in redirects.csv for the old article pointing to the new article. Note: It is important that the file has `.md` extension. @@ -194,7 +195,8 @@ Video demo available [here 🧵](https://expensify.slack.com/archives/C02NK2DQWU 1. Open github's in built code editor by pressing `.` on your keyboard. ([instructions here](https://docs.github.com/en/codespaces/the-githubdev-web-based-editor#opening-the-githubdev-editor)) 2. Go to the article that you want to hide `docs/articles/...`. 3. Drag and drop the article inside the hidden folder `docs/Hidden/`. -4. Commit the changes and raise a PR. +4. Add a redirect for it in `docs/redirects.csv` to ensure that we don't have broken links. You can choose to point it to the home page or the article's hub. +5. Commit the changes and raise a PR. # How the site is deployed This site is hosted on Cloudflare pages. Whenever code is merged to main, the github action `deployExpensifyHelp` will run.