Skip to content

Commit 0795b88

Browse files
authored
[FEATURE] Generate guides registry and refactor file indexing (#17)
Leaner and better documented code.
1 parent fa438f8 commit 0795b88

File tree

12 files changed

+250
-387
lines changed

12 files changed

+250
-387
lines changed

Documentation/10GettingStarted/20BasicConfiguration/10BackendBasics/EnablingAndDisablingAPageInTheListModule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ You have now disabled and re-enabled a page using TYPO3's List Module.
6666

6767
A page tree can also be enabled and disabled in other ways than this:
6868

69-
* [Enabling and disabling a page in the page properties](EnablingAndDisablingAPageInThePageProperties)
69+
* [Enabling and disabling a page in the page properties](EnablingAndDisablingAPageInThePageProperties.md)
7070
* [Enabling and disabling a page in the page tree](EnablingAndDisablingAPageInThePageTree.md)
7171

7272
## Resources
7373

74-
* [Enabling and disabling a page in the page properties](EnablingAndDisablingAPageInThePageProperties)
74+
* [Enabling and disabling a page in the page properties](EnablingAndDisablingAPageInThePageProperties.md)
7575
* [Enabling and disabling a page in the page tree](EnablingAndDisablingAPageInThePageTree.md)
7676
* [Introduction to the TYPO3 Backend](https://docs.typo3.org/permalink/t3start:backend)

Documentation/10GettingStarted/20BasicConfiguration/10BackendBasics/EnablingAndDisablingAPageInThePageProperties.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ You have now disabled and re-enabled a page using TYPO3's page properties interf
6868

6969
A page tree can also be enabled and disabled in other ways than this:
7070

71-
* [Enabling and disabling a page in the page tree](EnablingAndDisablingAPageInThePageTree)
71+
* [Enabling and disabling a page in the page tree](EnablingAndDisablingAPageInThePageTree.md)
7272
* [Enabling and disabling a page in the List module](EnablingAndDisablingAPageInTheListModule.md)
7373

7474
## Resources
7575

76-
* [Enabling and disabling a page in the page tree](EnablingAndDisablingAPageInThePageTree)
76+
* [Enabling and disabling a page in the page tree](EnablingAndDisablingAPageInThePageTree.md)
7777
* [Enabling and disabling a page in the List module](EnablingAndDisablingAPageInTheListModule.md)
7878
* [Introduction to the TYPO3 Backend](https://docs.typo3.org/permalink/t3start:backend)

Documentation/10GettingStarted/20BasicConfiguration/10BackendBasics/EnablingAndDisablingAPageInThePageTree.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ You have now disabled and re-enabled a page using the context menu of TYPO3's pa
4949

5050
A page tree can also be enabled and disabled in other ways than this:
5151

52-
* [Enabling and disabling a page in the page properties](EnablingAndDisablingAPageInThePageProperties)
52+
* [Enabling and disabling a page in the page properties](EnablingAndDisablingAPageInThePageProperties.md)
5353
* [Enabling and disabling a page in the List module](EnablingAndDisablingAPageInTheListModule.md)
5454

5555
## Resources
5656

57-
* [Enabling and disabling a page in the page properties](EnablingAndDisablingAPageInThePageProperties)
57+
* [Enabling and disabling a page in the page properties](EnablingAndDisablingAPageInThePageProperties.md)
5858
* [Enabling and disabling a page in the List module](EnablingAndDisablingAPageInTheListModule.md)
5959
* [Introduction to the TYPO3 Backend](https://docs.typo3.org/permalink/t3start:backend)

Documentation/20BuildingWebsites/10ContentManagement/20CreateCustomContentElements/CustomizeAContentElementTemplate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ The sitepackage extension is already configured so TYPO3 will look for custom co
5858
<f:image image="{page.files.0}" height="250" /\>
5959
```
6060

61-
3. Clear TYPO3's cache as described in [Clearing the Frontend Cache in the TYPO3 Backend](../../../10GettingStarted/20BasicConfiguration/10BackendBasics/ClearingTheFrontendCacheInTheTypo3Backend.md)
61+
3. Clear TYPO3's cache as described in [Clearing the Frontend Cache in the TYPO3 Backend](ClearingTheFrontendCacheInTheTypo3Backend.md)
6262

6363
## Summary
6464

@@ -72,7 +72,7 @@ The final result should look something like this:
7272

7373
Now that you have overridden a content element's Fluid template, you might like to:
7474

75-
* [Add custom CSS Styles to a Fluid Template](../../40FrontendDevelopment/40AddCustomJavaScriptAndCSS/AddCustomCssStylesToAFluidTemplate.md)
75+
* [Add custom CSS Styles to a Fluid Template](AddCustomCssStylesToAFluidTemplate.md)
7676

7777
## Resources
7878

Lines changed: 1 addition & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,3 @@
11
# Guides Registry
22

3-
The full list of step-by-step guides. See [How to Place Guides in the Registry Structure](../90Contribute/30UnderstandingTheStructure/20PlaceGuidesInTheStructure.md) to add a new guide.
4-
5-
### Getting Started
6-
7-
**Installation**
8-
9-
- [Install TYPO3 With Composer](../10GettingStarted/10Installation/10InstallTYPO3WithComposer/Index.md)
10-
- [Install TYPO3 Without Composer](../10GettingStarted/10Installation/20InstallTYPO3WithoutComposer/Index.md)
11-
- [Setup TYPO3 With DDEV](../10GettingStarted/10Installation/30SetUpTYPO3WithDDEV/Index.md)
12-
- [Upgrade an Existing TYPO3 Installation](../10GettingStarted/10Installation/Index.md)
13-
14-
**Basic Configuration**
15-
16-
- [Backend Basics](../10GettingStarted/20BasicConfiguration/10BackendBasics/Index.md)
17-
- [Setup a Site Configuration](../10GettingStarted/20BasicConfiguration/30SetUpASiteConfiguration/Index.md)
18-
- [Implement SiteSets (v13+)](../10GettingStarted/20BasicConfiguration/Index.md)
19-
20-
**Content Creation**
21-
22-
- [Create and Organize Pages](../10GettingStarted/30ContentCreation/10CreateAndOrganizePages/Index.md)
23-
- [Add Various Content Elements](../10GettingStarted/30ContentCreation/20AddVariousContentElements/Index.md)
24-
- [Work with the Rich Text Editor](../10GettingStarted/30ContentCreation/30WorkWithTheRichTextEditor/Index.md)
25-
- [Manage Media Assets](../10GettingStarted/30ContentCreation/40ManageMediaAssets/Index.md)
26-
27-
**Site Packages**
28-
29-
- [Create a Basic Site Package](../10GettingStarted/40SitePackages/10CreateABasicSitePackage/Index.md)
30-
- [Use the Bootstrap Package](../10GettingStarted/40SitePackages/20UseTheBootstrapPackage/Index.md)
31-
- [Customize Templates](../10GettingStarted/40SitePackages/30CustomizeTemplates/Index.md)
32-
- [Implement Your Design](../10GettingStarted/40SitePackages/40ImplementYourDesign/Index.md)
33-
34-
### Building Websites
35-
36-
**Content Management**
37-
38-
- [Setup Page Types](../20BuildingWebsites/10ContentManagement/10SetUpPageTypes/Index.md)
39-
- [Create Custom Content Elements](../20BuildingWebsites/10ContentManagement/20CreateCustomContentElements/Index.md)
40-
- [Configure the Backend Layout](../20BuildingWebsites/10ContentManagement/30ConfigureTheBackendLayout/Index.md)
41-
- [Manage Backend User Permissions](../20BuildingWebsites/10ContentManagement/40ManageBackendUserPermissions/Index.md)
42-
43-
**Multilingual Websites**
44-
45-
- [Setup Multiple Languages](../20BuildingWebsites/20MultilingualWebsites/10SetUpMultipleLanguages/Index.md)
46-
- [Translate Content](../20BuildingWebsites/20MultilingualWebsites/20TranslateContent/Index.md)
47-
- [Manage Language Fallbacks](../20BuildingWebsites/20MultilingualWebsites/30ManageLanguageFallbacks/Index.md)
48-
- [Work with Translation Services](../20BuildingWebsites/20MultilingualWebsites/40WorkWithTranslationServices/Index.md)
49-
50-
**Extensions**
51-
52-
- [Find and Install Extensions](../20BuildingWebsites/30Extensions/10FindAndInstallExtensions/Index.md)
53-
- [Configure Common Extensions](../20BuildingWebsites/30Extensions/20ConfigureCommonExtensions/Index.md)
54-
- [Customize Extension Templates](../20BuildingWebsites/30Extensions/30CustomizeExtensionTemplates/Index.md)
55-
- [Troubleshoot Extension Issues](../20BuildingWebsites/30Extensions/40TroubleshootExtensionIssues/Index.md)
56-
57-
**Frontend Development**
58-
59-
- [Understand Fluid Templates](../20BuildingWebsites/40FrontendDevelopment/10UnderstandFluidTemplates/Index.md)
60-
- [Create Responsive Layouts](../20BuildingWebsites/40FrontendDevelopment/20CreateResponsiveLayouts/Index.md)
61-
- [Implement Frontend User Registration](../20BuildingWebsites/40FrontendDevelopment/30ImplementFrontendUserRegistration/Index.md)
62-
- [Add Custom Java Script and CSS](../20BuildingWebsites/40FrontendDevelopment/40AddCustomJavaScriptAndCSS/Index.md)
63-
64-
### Advanced Implementation
65-
66-
**Extension Development**
67-
68-
- [Create a Basic Extension](../30AdvancedImplementation/10ExtensionDevelopment/10CreateABasicExtension/Index.md)
69-
- [Develop with Extbase and Fluid](../30AdvancedImplementation/10ExtensionDevelopment/20DevelopWithExtbaseAndFluid/Index.md)
70-
- [Build Non-Extbase Extensions](../30AdvancedImplementation/10ExtensionDevelopment/30BuildNon-ExtbaseExtensions/Index.md)
71-
- [Create Extension APIs](../30AdvancedImplementation/10ExtensionDevelopment/40CreateExtensionAPIs/Index.md)
72-
73-
**System Integration**
74-
75-
- [Connect to External Services](../30AdvancedImplementation/20SystemIntegration/10ConnectToExternalServices/Index.md)
76-
- [Implement Single Sign-On (SSO)](../30AdvancedImplementation/20SystemIntegration/20ImplementSingleSign-On/Index.md)
77-
- [Setup REST APIs](../30AdvancedImplementation/20SystemIntegration/30SetUpRESTAPIs/Index.md)
78-
- [Integrate with Third-party Systems](../30AdvancedImplementation/20SystemIntegration/40IntegrateWithThird-partySystems/Index.md)
79-
80-
**Performance Optimization**
81-
82-
- [Configure Caching](../30AdvancedImplementation/30PerformanceOptimization/10ConfigureCaching/Index.md)
83-
- [Setup a Content Delivery Network (CDN)](../30AdvancedImplementation/30PerformanceOptimization/20SetUpACDN/Index.md)
84-
- [Database Optimization](../30AdvancedImplementation/30PerformanceOptimization/30DatabaseOptimization/Index.md)
85-
- [Implement Static Site Generation (SSG)](../30AdvancedImplementation/30PerformanceOptimization/40ImplementStaticSiteGeneration/Index.md)
86-
87-
**Deployment and DevOps**
88-
89-
- [Setup CICD Pipelines](../30AdvancedImplementation/40DeploymentAndDevOps/10SetUpCICDPipelines/Index.md)
90-
- [Implement Git Workflows](../30AdvancedImplementation/40DeploymentAndDevOps/20ImplementGitWorkflows/Index.md)
91-
- [Containerization with Docker](../30AdvancedImplementation/40DeploymentAndDevOps/30ContainerizationWithDocker/Index.md)
92-
- [Kubernetes Deployment](../30AdvancedImplementation/40DeploymentAndDevOps/40KubernetesDeployment/Index.md)
93-
94-
### Maintenance and Security
95-
96-
**Regular Maintenance**
97-
98-
- [Backup and Restore Procedures](../40MaintenanceAndSecurity/10RegularMaintenance/10BackupAndRestoreProcedures/Index.md)
99-
- [Update TYPO3 Core](../40MaintenanceAndSecurity/10RegularMaintenance/20UpdateTYPO3Core/Index.md)
100-
- [Update Extensions](../40MaintenanceAndSecurity/10RegularMaintenance/30UpdateExtensions/Index.md)
101-
- [Database Maintenance Tasks](../40MaintenanceAndSecurity/10RegularMaintenance/40DatabaseMaintenanceTasks/Index.md)
102-
103-
**Security**
104-
105-
- [Implmement Security Best Practices](../40MaintenanceAndSecurity/20Security/10ImplementSecurityBestPractices/Index.md)
106-
- [Setup HTTPS](../40MaintenanceAndSecurity/20Security/20SetUpHTTPS/Index.md)
107-
- [Manage User Authentication](../40MaintenanceAndSecurity/20Security/30ManageUserAuthentication/Index.md)
108-
- [Security Incident Response](../40MaintenanceAndSecurity/20Security/40SecurityIncidentResponse/Index.md)
109-
110-
**Monitoring**
111-
112-
- [Setup Application Monitoring](../40MaintenanceAndSecurity/30Monitoring/10SetUpApplicationMonitoring/Index.md)
113-
- [Configure Log Management](../40MaintenanceAndSecurity/30Monitoring/20ConfigureLogManagement/Index.md)
114-
- [Implement Alerts](../40MaintenanceAndSecurity/30Monitoring/30ImplementAlerts/Index.md)
115-
- [Performance Monitoring](../40MaintenanceAndSecurity/30Monitoring/40PerformanceMonitoring/Index.md)
116-
117-
**Troubleshooting**
118-
119-
- [Debug Common Issues](../40MaintenanceAndSecurity/40Troubleshooting/10DebugCommonIssues/Index.md)
120-
- [Use the Admin Panel](../40MaintenanceAndSecurity/40Troubleshooting/20UseTheAdminPanel/Index.md)
121-
- [Work With Exception Logs](../40MaintenanceAndSecurity/40Troubleshooting/30WorkWithExceptionLogs/Index.md)
122-
- [Get Community Support](../40MaintenanceAndSecurity/40Troubleshooting/40GetCommunitySupport/Index.md)
3+
Contents are generated automatically.

Documentation/90Contribute/20ContributorGuide/30UsingTheTemplate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,9 +165,9 @@ In this example, each of the numbered steps link to pre-existing step-by-step gu
165165

166166
*H2* Create a multilingual website
167167

168-
1. [Set up multiple languages](.)
169-
2. [Translate content into other languages](.)
170-
3. [Manage language fallbacks](.)
168+
1. [Set up multiple languages](30UsingTheTemplate.md)
169+
2. [Translate content into other languages](30UsingTheTemplate.md)
170+
3. [Manage language fallbacks](30UsingTheTemplate.md)
171171

172172
#### Tips for when you have too many steps
173173

0 commit comments

Comments
 (0)