From 0dacb151749f74dec214edd30537d200824e6923 Mon Sep 17 00:00:00 2001 From: Prokyonn Date: Wed, 11 Dec 2024 14:38:10 +0100 Subject: [PATCH 1/3] Adjust webspace naming --- book/getting-started.rst | 2 +- book/webspaces.rst | 24 ++++++++++++------------ bundles/markup/index.rst | 2 +- bundles/markup/link.rst | 20 ++++++++++---------- cookbook/create-new-webspace.rst | 4 ++-- cookbook/dump-sitemap.rst | 4 ++-- cookbook/sitemap-provider.rst | 2 +- 7 files changed, 29 insertions(+), 29 deletions(-) diff --git a/book/getting-started.rst b/book/getting-started.rst index 668aedd3..d3f06c79 100644 --- a/book/getting-started.rst +++ b/book/getting-started.rst @@ -59,7 +59,7 @@ webspaces configures a content tree. Each content tree may contain translations for different locales. The default webspace configuration is located in -``config/webspaces/example.xml``. Rename this file so that it matches +``config/webspaces/website.xml``. Rename this file so that it matches the name of your project. To get started, change the ```` and the ```` of the webspace to the diff --git a/book/webspaces.rst b/book/webspaces.rst index 9d301cca..bfc6693f 100644 --- a/book/webspaces.rst +++ b/book/webspaces.rst @@ -24,11 +24,11 @@ following paragraphs. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.sulu.io/webspace/webspace http://schemas.sulu.io/webspace/webspace-1.1.xsd"> - Example - example + Website + website - example + website @@ -36,7 +36,7 @@ following paragraphs. - example + default default @@ -80,18 +80,18 @@ following paragraphs. - example - example + Website + website - example.org + website.org - example.lo + website.lo @@ -270,7 +270,7 @@ localization. The following fragment shows again how to this: .. code-block:: xml - www.example.org + www.website.org Since it is possible to define localizations without a country, this attribute is also optional here. However, the combination of language and country here @@ -284,13 +284,13 @@ following line for an example: .. code-block:: xml - www.example.org/{localization} + www.website.org/{localization} Placeholder are expressions in curly braces, which will be expanded to every possible value. For the above example that means, that an URL for every localization defined will be generated. So if you have a localization ``de-at`` -and ``en-us``, the system will create URLs for ``www.example.org/de-at`` and -``www.example.org/en-us``. +and ``en-us``, the system will create URLs for ``www.website.org/de-at`` and +``www.website.org/en-us``. In the following table all the possible placeholders are listed, and explains the values of them by using the ``de-at``-localization: diff --git a/bundles/markup/index.rst b/bundles/markup/index.rst index 58f17a13..648f9b66 100644 --- a/bundles/markup/index.rst +++ b/bundles/markup/index.rst @@ -26,7 +26,7 @@ a link to another page. This tag will be replaced via a valid anchor where the - Page Title + Page Title diff --git a/bundles/markup/link.rst b/bundles/markup/link.rst index 7db64de8..49db35d6 100644 --- a/bundles/markup/link.rst +++ b/bundles/markup/link.rst @@ -27,14 +27,14 @@ Example .. code-block:: html - Page Title - Page Title - Link Text - Anchor Example - Query String Example - Link Text - Media Title - Link Text + Page Title + Page Title + Link Text + Anchor Example + Query String Example + Link Text + Media Title + Link Text Provider Attributes ------------------- @@ -59,8 +59,8 @@ There might be situations where you need to know which provider was used even af .. code-block:: html - Link Text - Media Title + Link Text + Media Title Now you will be able to target the links in CSS and Javascript by using the data attribute as a selector. This allows things such as: diff --git a/cookbook/create-new-webspace.rst b/cookbook/create-new-webspace.rst index 9e40d6ba..fa36bebe 100644 --- a/cookbook/create-new-webspace.rst +++ b/cookbook/create-new-webspace.rst @@ -3,7 +3,7 @@ Adding new Webspace To create a new webspace you have to create a new file within the `config/webspaces` directory. The content of the file should be quite -similar to the `example.xml`_ file in this folder. +similar to the `website.xml`_ file in this folder. .. note:: @@ -37,4 +37,4 @@ If you have any error you can use the following command to validate your webspac php bin/adminconsole sulu:content:validate:webspaces -.. _example.xml: https://github.com/sulu/skeleton/blob/2.x/config/webspaces/example.xml +.. _website.xml: https://github.com/sulu/skeleton/blob/2.6/config/webspaces/website.xml diff --git a/cookbook/dump-sitemap.rst b/cookbook/dump-sitemap.rst index fa730d8e..7580bad8 100644 --- a/cookbook/dump-sitemap.rst +++ b/cookbook/dump-sitemap.rst @@ -31,7 +31,7 @@ Have a look at the official Symfony Documentation about # config/packages/framework.yaml framework: router: - default_uri: 'https://example.org' + default_uri: 'https://website.org' .. tip:: @@ -46,7 +46,7 @@ If you are using a Symfony version before 5.1, you need to configure the # config/services.yaml parameters: router.request_context.scheme: 'https' - router.request_context.host: 'example.org' + router.request_context.host: 'website.org' Switch back to on the fly generation ------------------------------------ diff --git a/cookbook/sitemap-provider.rst b/cookbook/sitemap-provider.rst index 5a6e672b..37b357bc 100644 --- a/cookbook/sitemap-provider.rst +++ b/cookbook/sitemap-provider.rst @@ -74,7 +74,7 @@ implemented in the Repository. public function getMaxPage($scheme, $host) { - if ($host !== 'example.org') { + if ($host !== 'website.org') { // If the pages are only for a specific return 0; } From 7ebcaa998441a8a217b8ecfcff2cf7874aa6fa0b Mon Sep 17 00:00:00 2001 From: Prokyonn Date: Wed, 11 Dec 2024 15:57:14 +0100 Subject: [PATCH 2/3] Rename website to example.org --- book/webspaces.rst | 10 +++++----- bundles/markup/index.rst | 2 +- bundles/markup/link.rst | 20 ++++++++++---------- cookbook/caching-with-varnish.rst | 2 +- cookbook/dump-sitemap.rst | 4 ++-- cookbook/sitemap-provider.rst | 2 +- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/book/webspaces.rst b/book/webspaces.rst index bfc6693f..d300ca73 100644 --- a/book/webspaces.rst +++ b/book/webspaces.rst @@ -86,7 +86,7 @@ following paragraphs. - website.org + example.org @@ -270,7 +270,7 @@ localization. The following fragment shows again how to this: .. code-block:: xml - www.website.org + www.example.org Since it is possible to define localizations without a country, this attribute is also optional here. However, the combination of language and country here @@ -284,13 +284,13 @@ following line for an example: .. code-block:: xml - www.website.org/{localization} + www.example.org/{localization} Placeholder are expressions in curly braces, which will be expanded to every possible value. For the above example that means, that an URL for every localization defined will be generated. So if you have a localization ``de-at`` -and ``en-us``, the system will create URLs for ``www.website.org/de-at`` and -``www.website.org/en-us``. +and ``en-us``, the system will create URLs for ``www.example.org/de-at`` and +``www.example.org/en-us``. In the following table all the possible placeholders are listed, and explains the values of them by using the ``de-at``-localization: diff --git a/bundles/markup/index.rst b/bundles/markup/index.rst index 648f9b66..ea9d1f6f 100644 --- a/bundles/markup/index.rst +++ b/bundles/markup/index.rst @@ -26,7 +26,7 @@ a link to another page. This tag will be replaced via a valid anchor where the - Page Title + Page Title diff --git a/bundles/markup/link.rst b/bundles/markup/link.rst index 49db35d6..07851326 100644 --- a/bundles/markup/link.rst +++ b/bundles/markup/link.rst @@ -27,14 +27,14 @@ Example .. code-block:: html - Page Title - Page Title - Link Text - Anchor Example - Query String Example - Link Text - Media Title - Link Text + Page Title + Page Title + Link Text + Anchor Example + Query String Example + Link Text + Media Title + Link Text Provider Attributes ------------------- @@ -59,8 +59,8 @@ There might be situations where you need to know which provider was used even af .. code-block:: html - Link Text - Media Title + Link Text + Media Title Now you will be able to target the links in CSS and Javascript by using the data attribute as a selector. This allows things such as: diff --git a/cookbook/caching-with-varnish.rst b/cookbook/caching-with-varnish.rst index 41cc21c6..dadd7b9d 100644 --- a/cookbook/caching-with-varnish.rst +++ b/cookbook/caching-with-varnish.rst @@ -198,7 +198,7 @@ And now have a look at the headers on your website: .. code-block:: bash - $ curl -I mywebsite.com + $ curl -I example.org HTTP/1.1 200 OK # ... Via: 1.1 varnish diff --git a/cookbook/dump-sitemap.rst b/cookbook/dump-sitemap.rst index 7580bad8..fa730d8e 100644 --- a/cookbook/dump-sitemap.rst +++ b/cookbook/dump-sitemap.rst @@ -31,7 +31,7 @@ Have a look at the official Symfony Documentation about # config/packages/framework.yaml framework: router: - default_uri: 'https://website.org' + default_uri: 'https://example.org' .. tip:: @@ -46,7 +46,7 @@ If you are using a Symfony version before 5.1, you need to configure the # config/services.yaml parameters: router.request_context.scheme: 'https' - router.request_context.host: 'website.org' + router.request_context.host: 'example.org' Switch back to on the fly generation ------------------------------------ diff --git a/cookbook/sitemap-provider.rst b/cookbook/sitemap-provider.rst index 37b357bc..5a6e672b 100644 --- a/cookbook/sitemap-provider.rst +++ b/cookbook/sitemap-provider.rst @@ -74,7 +74,7 @@ implemented in the Repository. public function getMaxPage($scheme, $host) { - if ($host !== 'website.org') { + if ($host !== 'example.org') { // If the pages are only for a specific return 0; } From 4b8c06787a2b3089e0e20ac5a1926b9b903dde94 Mon Sep 17 00:00:00 2001 From: Prokyonn Date: Wed, 11 Dec 2024 15:58:35 +0100 Subject: [PATCH 3/3] Change .lo to .localhost --- book/webspaces.rst | 2 +- bundles/custom_url.rst | 10 +++++----- cookbook/custom-error-page.rst | 10 +++++----- cookbook/web-server/apache.rst | 14 +++++++------- cookbook/web-server/nginx.rst | 8 ++++---- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/book/webspaces.rst b/book/webspaces.rst index d300ca73..d3b5e3fe 100644 --- a/book/webspaces.rst +++ b/book/webspaces.rst @@ -91,7 +91,7 @@ following paragraphs. - website.lo + example.localhost diff --git a/bundles/custom_url.rst b/bundles/custom_url.rst index c0172296..07ea81d4 100644 --- a/bundles/custom_url.rst +++ b/bundles/custom_url.rst @@ -59,14 +59,14 @@ The base-domains (which can be selected) will be configured in the ... - + - sulu.lo/{localization} + example.org/{localization} - sulu.lo/* - *.sulu.lo - *.sulu.lo/* + example.org/* + *.example.org + *.example.org/* diff --git a/cookbook/custom-error-page.rst b/cookbook/custom-error-page.rst index 4522397e..0e77569c 100644 --- a/cookbook/custom-error-page.rst +++ b/cookbook/custom-error-page.rst @@ -97,8 +97,8 @@ Examples: .. code-block:: bash - sulu.lo/ch._twig_error_test ANY ANY sulu.lo /ch/_error/{code}.{_format} - sulu.lo/en._twig_error_test ANY ANY sulu.lo /en/_error/{code}.{_format} - sulu.lo/fr._twig_error_test ANY ANY sulu.lo /fr/_error/{code}.{_format} - sulu.lo/de._twig_error_test ANY ANY sulu.lo /de/_error/{code}.{_format} - sulu.lo._twig_error_test ANY ANY sulu.lo /_error/{code}.{_format} + example.org/ch._twig_error_test ANY ANY example.org /ch/_error/{code}.{_format} + example.org/en._twig_error_test ANY ANY example.org /en/_error/{code}.{_format} + example.org/fr._twig_error_test ANY ANY example.org /fr/_error/{code}.{_format} + example.org/de._twig_error_test ANY ANY example.org /de/_error/{code}.{_format} + example.org._twig_error_test ANY ANY example.org /_error/{code}.{_format} diff --git a/cookbook/web-server/apache.rst b/cookbook/web-server/apache.rst index 16d751e9..03f0c387 100644 --- a/cookbook/web-server/apache.rst +++ b/cookbook/web-server/apache.rst @@ -16,16 +16,16 @@ system, this file can be found in different places: * Unix: ``/etc/hosts`` * Windows: ``%SystemRoot%\System32\drivers\etc\hosts`` -On a development machine, we could use the domain `sulu.lo` ("lo" stands for +On a development machine, we could use the domain `sulu.lo` or `sulu.localhost` ("lo" stands for "local"). Add that domain to the end of the `hosts` file: .. code-block:: text # ... - 127.0.0.1 sulu.lo + 127.0.0.1 example.org -When you type the URL http://sulu.lo in your browser, the browser will now +When you type the URL http://example.org in your browser, the browser will now load the page from your computer. .. note:: @@ -37,14 +37,14 @@ But before it works, we need to tell Apache what to do when that URL is loaded. Virtual Host Configuration -------------------------- -Let's add the Apache configuration file for the `sulu.lo` domain. +Let's add the Apache configuration file for the `example.org` domain. .. code-block:: apache - DocumentRoot "/var/www/sulu.lo/public" - ServerName sulu.lo - + DocumentRoot "/var/www/example.org/public" + ServerName example.org + Options Indexes FollowSymLinks AllowOverride All Require all granted diff --git a/cookbook/web-server/nginx.rst b/cookbook/web-server/nginx.rst index 52710973..8120974e 100644 --- a/cookbook/web-server/nginx.rst +++ b/cookbook/web-server/nginx.rst @@ -9,11 +9,11 @@ The Nginx configuration could look something like. listen 80; listen [::]:80; - server_name sulu.lo; - root /var/www/sulu.lo/public; + server_name example.org; + root /var/www/example.org/public; - error_log /var/log/nginx/sulu.lo.error.log; - access_log /var/log/nginx/sulu.lo.at.access.log; + error_log /var/log/nginx/example.org.error.log; + access_log /var/log/nginx/example.org.at.access.log; # recommended security headers add_header X-Frame-Options sameorigin;