From a3a163c0585b8b31b0aeee752fed7ad598a4b57e Mon Sep 17 00:00:00 2001 From: Lukas Puehringer Date: Mon, 31 Mar 2025 16:08:35 +0200 Subject: [PATCH] Remove stray docs how-to Fixes #31 Signed-off-by: Lukas Puehringer --- how_to_contribute_to_docs.md | 78 ------------------------------------ 1 file changed, 78 deletions(-) delete mode 100644 how_to_contribute_to_docs.md diff --git a/how_to_contribute_to_docs.md b/how_to_contribute_to_docs.md deleted file mode 100644 index 03da332..0000000 --- a/how_to_contribute_to_docs.md +++ /dev/null @@ -1,78 +0,0 @@ -# How to Contribute to Docs - -## **Website Documentation Guidelines** -If you haven't build website locally yet, run following commands inside `theupdateframework` directory (use your [forked](https://www.google.com/url?sa=t&source=web&rct=j&opi=89978449&url=https://docs.github.com/articles/fork-a-repo&ved=2ahUKEwjexbXp6aqGAxXP1zgGHYMfB3AQFnoECAkQAQ&usg=AOvVaw3knkDqfZXHdtlZVtWiPqst) repository) -``` - $ yarn install - $ hugo server -``` -This will run website locally on http://localhost:1313 by default. - -The [content](https://github.com/theupdateframework/theupdateframework.io/tree/master/content) directory is used as a source for Markdown files (Docs), which Hugo uses to generate the TUF website resources. - -### **Add Menu on Website** -___ - -The starting step is to add a route to render your Markdown file. - -Navigate to the [config.toml](https://github.com/theupdateframework/theupdateframework.io/blob/master/config.toml) file. - -### **Create Menu with Submenu options** -When the Menu contains SubMenu options: - -- Use the following format: -```toml -[[menu.main]] -name = "" -identifier ="" -weight = -``` -- Place the Menu at the relevent position in [config.toml](https://github.com/theupdateframework/theupdateframework.io/blob/master/config.toml) based on its weight. -- Restart the Hugo server to see changes. - -### **Create Menu without SubMenu options** - -When the Menu does not contain any Submenu options: - -- Use the following format: -```toml -[[menu.main]] -name = "" -url = "//" -weight = -``` - -- Place the section at the relevant position according to its weight in [config.toml](https://github.com/theupdateframework/theupdateframework.io/blob/master/config.toml). -- Restart the Hugo server to see changes. - -### **Add SubMenu options to Parent Menu** -___ - -- Use the following format: -```toml -[[menu.main]] -name = "" -parent = "" -url = "/" #This should be in lowercase, relates to SubMenu heading, and should not conflict with other routes -weight = -``` - -- Position the SubMenu at the relevant place according to its weight in [config.toml](https://github.com/theupdateframework/theupdateframework.io/blob/master/config.toml). -- Restart the Hugo server to see changes. - - - -### **Markdown Files for Menu or SubMenu options** -___ - -- The Markdown file name should be `.md` for consistency. -- Front Matter is essential on top of every Markdown. In Hugo, the title is defined like this: -```markdown ---- -title: ---- -``` -Content can be written according to [Markdown rules](https://www.markdownguide.org/basic-syntax/) subject to [Hugo Markdown Support](https://www.markdownguide.org/tools/hugo/#hugo-markdown-support). - -### Need Help? -If you have any question, please reach out to us [here](https://github.com/theupdateframework/community?tab=readme-ov-file#tuf-community).