diff --git a/docs/generate-toc.py b/docs/generate-toc.py index f32da7d6..21d52965 100755 --- a/docs/generate-toc.py +++ b/docs/generate-toc.py @@ -78,56 +78,56 @@ class Gen(object): TOC = [ Page( - "General Information", + "Tutorial", None, children=[ - Page("Preface and Legal Notices", "preface/index.md"), - Page("About This Manual", "general/about.md"), - Page("How to Report Bugs or Get Help", "general/report.md"), - Page("Credits", "general/credits.md"), - Page("History", "overview/history.md"), - Page("Architecture", "overview/architecture.md"), + Page("Getting Started", "tutorial/getting_started.md"), + Page( + "Environmental Considerations", + "tutorial/subs/environment_consideration.md", + ), + Page("System Preparation", "tutorial/subs/system_preparation.md"), + Page( + "Installing for Development", + "tutorial/subs/install_for_development.md", + ), + Page( + "Installing for Production", + "tutorial/subs/install_for_production_use.md", + ), + Page( + "Special instructions for CentOS7 users", + "tutorial/subs/special_for_centos7.md", + ), + Page("Your First Email", "tutorial/subs/your_first_email.md"), + Page( + "Beyond Basics", + "tutorial/beyond_basics.md", + children=[ + Page("Configuring DKIM", "tutorial/subs/dkim.md"), + Page("Configuring TLS", "tutorial/subs/tls.md"), + ], + ), + Page( + "Advanced Configurations", + "tutorial/advanced_config.md", + children=[ + Page("Lua Resources", "tutorial/subs/lua_resources.md"), + Page("Lua Functions", "tutorial/subs/lua_functions.md"), + ], + ), ], ), Page( "User Guide", None, children=[ - Page("Getting Started", "guide/getting_started.md"), - Page( - "Environmental Considerations", - "guide/subs/environment_consideration.md", - ), - Page("System Preparation", "guide/subs/system_preparation.md"), - Page( - "Installing for Development", - "guide/subs/install_for_development.md", - ), - Page( - "Installing for Production", - "guide/subs/install_for_production_use.md", - ), - Page( - "Special instructions for CentOS7 users", - "guide/subs/special_for_centos7.md", - ), - Page("Your First Email", "guide/subs/your_first_email.md"), - Page( - "Beyond Basics", - "guide/beyond_basics.md", - children=[ - Page("Configuring DKIM", "guide/subs/dkim.md"), - Page("Configuring TLS", "guide/subs/tls.md"), - ], - ), - Page( - "Advanced Configurations", - "guide/advanced_config.md", - children=[ - Page("Lua Resources", "guide/subs/lua_resources.md"), - Page("Lua Functions", "guide/subs/lua_functions.md"), - ], - ), + Page("Preface and Legal Notices", "userguide/preface/index.md"), + Page("About This Manual", "userguide/general/about.md"), + Page("How to Report Bugs or Get Help", "userguide/general/report.md"), + Page("Credits", "userguide/general/credits.md"), + Page("History", "userguide/overview/history.md"), + Page("Architecture", "userguide/overview/architecture.md"), ], ), Page( diff --git a/docs/guide/advanced_config.md b/docs/tutorial/advanced_config.md similarity index 100% rename from docs/guide/advanced_config.md rename to docs/tutorial/advanced_config.md diff --git a/docs/guide/beyond_basics.md b/docs/tutorial/beyond_basics.md similarity index 100% rename from docs/guide/beyond_basics.md rename to docs/tutorial/beyond_basics.md diff --git a/docs/guide/getting_started.md b/docs/tutorial/getting_started.md similarity index 100% rename from docs/guide/getting_started.md rename to docs/tutorial/getting_started.md diff --git a/docs/guide/subs/dkim.md b/docs/tutorial/subs/dkim.md similarity index 100% rename from docs/guide/subs/dkim.md rename to docs/tutorial/subs/dkim.md diff --git a/docs/guide/subs/environment_consideration.md b/docs/tutorial/subs/environment_consideration.md similarity index 100% rename from docs/guide/subs/environment_consideration.md rename to docs/tutorial/subs/environment_consideration.md diff --git a/docs/guide/subs/install_for_development.md b/docs/tutorial/subs/install_for_development.md similarity index 100% rename from docs/guide/subs/install_for_development.md rename to docs/tutorial/subs/install_for_development.md diff --git a/docs/guide/subs/install_for_production_use.md b/docs/tutorial/subs/install_for_production_use.md similarity index 100% rename from docs/guide/subs/install_for_production_use.md rename to docs/tutorial/subs/install_for_production_use.md diff --git a/docs/guide/subs/lua_functions.md b/docs/tutorial/subs/lua_functions.md similarity index 100% rename from docs/guide/subs/lua_functions.md rename to docs/tutorial/subs/lua_functions.md diff --git a/docs/guide/subs/lua_resources.md b/docs/tutorial/subs/lua_resources.md similarity index 100% rename from docs/guide/subs/lua_resources.md rename to docs/tutorial/subs/lua_resources.md diff --git a/docs/guide/subs/special_for_centos7.md b/docs/tutorial/subs/special_for_centos7.md similarity index 100% rename from docs/guide/subs/special_for_centos7.md rename to docs/tutorial/subs/special_for_centos7.md diff --git a/docs/guide/subs/system_preparation.md b/docs/tutorial/subs/system_preparation.md similarity index 100% rename from docs/guide/subs/system_preparation.md rename to docs/tutorial/subs/system_preparation.md diff --git a/docs/guide/subs/tls.md b/docs/tutorial/subs/tls.md similarity index 100% rename from docs/guide/subs/tls.md rename to docs/tutorial/subs/tls.md diff --git a/docs/guide/subs/your_first_email.md b/docs/tutorial/subs/your_first_email.md similarity index 100% rename from docs/guide/subs/your_first_email.md rename to docs/tutorial/subs/your_first_email.md diff --git a/docs/general/about.md b/docs/userguide/general/about.md similarity index 100% rename from docs/general/about.md rename to docs/userguide/general/about.md diff --git a/docs/general/credits.md b/docs/userguide/general/credits.md similarity index 100% rename from docs/general/credits.md rename to docs/userguide/general/credits.md diff --git a/docs/general/report.md b/docs/userguide/general/report.md similarity index 100% rename from docs/general/report.md rename to docs/userguide/general/report.md diff --git a/docs/overview/architecture.md b/docs/userguide/overview/architecture.md similarity index 100% rename from docs/overview/architecture.md rename to docs/userguide/overview/architecture.md diff --git a/docs/overview/history.md b/docs/userguide/overview/history.md similarity index 100% rename from docs/overview/history.md rename to docs/userguide/overview/history.md diff --git a/docs/overview/index.md b/docs/userguide/overview/index.md similarity index 100% rename from docs/overview/index.md rename to docs/userguide/overview/index.md diff --git a/docs/preface/index.md b/docs/userguide/preface/index.md similarity index 100% rename from docs/preface/index.md rename to docs/userguide/preface/index.md