Skip to content

Commit e66836b

Browse files
committed
[TASK] Add site config trouble shooting section
releases: main, 13.4
1 parent 5ac3c59 commit e66836b

File tree

10 files changed

+134
-2
lines changed

10 files changed

+134
-2
lines changed
34.4 KB
Loading

Documentation/FirstProject/SiteManagement/Index.rst

Lines changed: 134 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@
66
Site Management
77
===============
88

9-
.. _siteconfiguration:
10-
.. _siterecords:
9+
.. contents:: Table of contents
10+
11+
.. _siteconfiguration:
12+
.. _siterecords:
1113
.. _site-configuration:
1214

1315
Create a new site configuration
@@ -66,3 +68,133 @@ After saving, a new file should be created in your project:
6668
.. literalinclude:: _config.yaml
6769
:language: yaml
6870
:caption: config/sites/example_site/config.yaml
71+
72+
.. _site-management-trouble:
73+
74+
Site management: Trouble shooting
75+
=================================
76+
77+
.. accordion::
78+
:name: siteManagementTrouble
79+
80+
.. accordion-item:: Set of Site Package not available
81+
:name: site-trouble-set-unavailable
82+
:header-level: 2
83+
:show:
84+
85+
If the set of your site package is not available make sure, that the
86+
site package extension is `Installed <https://docs.typo3.org/permalink/t3start:installing-extensions>`_.
87+
88+
If the site package is installed but the site package set is still not
89+
available the set or one of its dependencies might be corrupted.
90+
91+
.. versionadded:: 13.4.5
92+
93+
.. figure:: /FirstProject/SiteManagement/InvalidSiteSet.png
94+
:alt: Screenshot of the "Site Configuration" module with an invalid site set displayed
95+
96+
Invalid site sets are listed in the "Site Configuration" module with reasons why they are invalid.
97+
98+
The site sets are cached. If you change the site set configuration and
99+
see no difference, `clear the caches <https://docs.typo3.org/permalink/t3start:how-to-clear-cache>`_.
100+
101+
.. accordion-item:: This site depends on invalid site sets
102+
:name: site-trouble-set-invalid
103+
:header-level: 2
104+
105+
If a set or one of its dependencies get corrupted after it was already
106+
added to a site configuration, an error box is displayed in the table
107+
listing the configurations.
108+
109+
.. figure:: /FirstProject/SiteManagement/InvalidDependency.png
110+
:alt: Screenshot the site configuration module with a site set having an error message "This site depends on invalid site sets"
111+
112+
This can happen for example when you uninstall an extension on which
113+
your site package depends. In this case install the extension again or
114+
remove the dependency from your site package.
115+
116+
The site sets are cached. If you change the site set configuration and
117+
see no difference, `clear the caches <https://docs.typo3.org/permalink/t3start:how-to-clear-cache>`_.
118+
119+
.. accordion-item:: On saving TYPO3 keeps creating empty language configurations
120+
:name: site-trouble-duplicate-language
121+
:header-level: 2
122+
123+
On saving the site settings TYPO3 keeps creating empty language
124+
configurations.
125+
126+
This can happen if you deleted the language configuration with uid 0.
127+
If you only need to use one language this one language has to have the
128+
uid 0.
129+
130+
Edit the auto created language to fit your language needs.
131+
132+
.. figure:: /FirstProject/SiteManagement/EmptyLanguage.png
133+
:alt: An empty language configuration in the site settings prevents saving
134+
135+
Invalid site sets are listed in the "Site Configuration" module with reasons why they are invalid.
136+
137+
Sometimes it is easier to just edit the site configuration file:
138+
139+
.. code-block:: diff
140+
141+
base: 'https://site-introduction.ddev.site/'
142+
languages:
143+
-
144+
title: English
145+
enabled: true
146+
locale: en-US
147+
hreflang: ''
148+
base: /
149+
websiteTitle: ''
150+
navigationTitle: ''
151+
flag: global
152+
- languageId: 1
153+
+ languageId: 0
154+
rootPageId: 1
155+
websiteTitle: ''
156+
157+
Change the language id of the only language from 1 to 0.
158+
159+
.. accordion-item:: Malformed inline YAML string at line 17
160+
:name: site-trouble-yaml
161+
:header-level: 2
162+
163+
If you manually edited the site configuration and it contains a syntax
164+
error, the whole backend module might stop working:
165+
166+
.. figure:: /FirstProject/SiteManagement/MalformedYAML.png
167+
:alt: Whoops, looks like something went wrong: Malformed inline YAML string at line 17.
168+
169+
Malformed YAML can only be corrected by editing the config file.
170+
171+
Fix or delete the affected site configuration by editing the file, for
172+
example :file:`config/sites/my-site/config.yaml`.
173+
174+
175+
.. accordion-item:: No pages found
176+
:name: site-trouble-no-pages
177+
:header-level: 2
178+
179+
If you see the following you cannot add any site configuration until
180+
you fix the problem in the page tree:
181+
182+
.. figure:: /FirstProject/SiteManagement/NoPagesFound.png
183+
:alt: No pages found! Please add at least one page through the Page module.
184+
185+
Malformed YAML can only be corrected by editing the config file.
186+
187+
If you have not created any pages yet,
188+
`create a root page <https://docs.typo3.org/permalink/t3start:create-root-page>`_
189+
first.
190+
191+
If you have created pages but still see the message, set the flag
192+
"Use as Root Page" in the page properties, tab "Behavior" for the page
193+
that should be the startpage of your site. A root page is displayed with
194+
a globe icon in the page tree.
195+
196+
.. figure:: /FirstProject/SiteManagement/MarkPageAsRootpage.png
197+
:alt: Option "Use as Root Page" in the page properties.
198+
199+
At least one root page is required before you can create a site configuration.
200+
29.5 KB
Loading
28.7 KB
Loading
29 KB
Loading
13.2 KB
Loading
-9.5 KB
Loading
-11.8 KB
Loading
-16.5 KB
Loading
10.7 KB
Loading

0 commit comments

Comments
 (0)