[Docs] Update pushword.piedweb.com

Pushword · May 8, 2023 · 9aff46d · 9aff46d
1 parent 2be5263
commit 9aff46d
Show file tree

Hide file tree

Showing 28 changed files with 28 additions and 28 deletions.
diff --git a/docs/architecture.html b/docs/architecture.html
diff --git a/docs/command.html b/docs/command.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="bg-white dark:bg-gray-900 dark:text-gray-100 leading-tight overflow-x-hidden text-gray-900" lang=en><head><meta charset=UTF-8><meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name=viewport><link href=/assets/favicons/apple-touch-icon.png rel=apple-touch-icon sizes=180x180><link href=/assets/favicons/favicon-32x32.png rel=icon sizes=32x32 type=image/png><link href=/assets/favicons/favicon-16x16.png rel=icon sizes=16x16 type=image/png><link href=/assets/favicons/site.webmanifest rel=manifest><link color=#000000 href=/assets/favicons/safari-pinned-tab.svg rel=mask-icon><link href=/assets/favicons/favicon.ico rel="shortcut icon"><meta content=Pushword name=apple-mobile-web-app-title><meta content=Pushword name=application-name><meta content=#fff name=msapplication-TileColor><meta content=/assets/favicons/browserconfig.xml name=msapplication-config><meta content=#fff name=theme-color><title>	Manage your Pushword CMS with command </title><link href=/assets/tw.min.css?7f18cf710 rel=stylesheet><style>:root{--primary:#ef8206;--secondary:#d97706;--font-family:Inter var,ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol}</style><style>.nojs{display:inline-block}</style><script>document.head.insertAdjacentHTML('beforeend','<style>.nojs{display:none !important}<\/style>')</script><link href=https://pushword.piedweb.com/feed.xml rel=alternate title="Pushword &raquo; Flux" type=application/rss+xml><link href=https://pushword.piedweb.com/command rel=canonical><link href=https://pushword.piedweb.com/command hreflang=x-default rel=alternate><meta content="Manage your Pushword CMS with command" name=og:title><meta content=https://pushword.piedweb.com/command name=og:url><meta content=/media/og/command-16f037.png name=og:image><script>const base="/"</script> <body><div class="flex flex-col min-h-screen"><div class="flex flex-wrap items-stretch max-w-screen-2xl mx-auto" style=min-height:85vh><div class="lg:ml-0 lg:mr-0 lg:w-3/4 mx-auto order-2 w-full"><div class=pt-6></div> <div class="flex flex-wrap max-w-5xl"><div class="lg:order-1 lg:w-4/5 order-2 overflow-hidden w-full"><div class="dark:prose-light max-w-none p-3 prose"><h1>Command</h1> </div> </div> <div class="lg:w-4/5 order-4 overflow-hidden w-full"><div class="dark:prose-light max-w-3xl p-3 prose"><p>At any moment, you can get the avalaible command from symfony by typing <code>php bin/console list</code>. <p>Now, let's see what command we have and how useful there are. <p>The list above may vary depending on <a href=extensions>installed extensions</a> <p>To get more details on each command line, just type -h (eg <code>php bin/console pushword:user:create -h</code>) <pre><code class="shell"> pushword
+<!DOCTYPE html><html class="bg-white dark:bg-gray-900 dark:text-gray-100 leading-tight overflow-x-hidden text-gray-900" lang=en><head><meta charset=UTF-8><meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name=viewport><link href=/assets/favicons/apple-touch-icon.png rel=apple-touch-icon sizes=180x180><link href=/assets/favicons/favicon-32x32.png rel=icon sizes=32x32 type=image/png><link href=/assets/favicons/favicon-16x16.png rel=icon sizes=16x16 type=image/png><link href=/assets/favicons/site.webmanifest rel=manifest><link color=#000000 href=/assets/favicons/safari-pinned-tab.svg rel=mask-icon><link href=/assets/favicons/favicon.ico rel="shortcut icon"><meta content=Pushword name=apple-mobile-web-app-title><meta content=Pushword name=application-name><meta content=#fff name=msapplication-TileColor><meta content=/assets/favicons/browserconfig.xml name=msapplication-config><meta content=#fff name=theme-color><title>	Manage your Pushword CMS with command </title><link href=/assets/tw.min.css?7f18cf710 rel=stylesheet><style>:root{--primary:#ef8206;--secondary:#d97706;--font-family:Inter var,ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol}</style><style>.nojs{display:inline-block}</style><script>document.head.insertAdjacentHTML('beforeend','<style>.nojs{display:none !important}<\/style>')</script><link href=https://pushword.piedweb.com/feed.xml rel=alternate title="Pushword &raquo; Flux" type=application/rss+xml><link href=https://pushword.piedweb.com/command rel=canonical><link href=https://pushword.piedweb.com/command hreflang=x-default rel=alternate><meta content="Manage your Pushword CMS with command" name=og:title><meta content=https://pushword.piedweb.com/command name=og:url><meta content=https://pushword.piedweb.com/media/og/command-16f037.png name=og:image><script>const base="/"</script> <body><div class="flex flex-col min-h-screen"><div class="flex flex-wrap items-stretch max-w-screen-2xl mx-auto" style=min-height:85vh><div class="lg:ml-0 lg:mr-0 lg:w-3/4 mx-auto order-2 w-full"><div class=pt-6></div> <div class="flex flex-wrap max-w-5xl"><div class="lg:order-1 lg:w-4/5 order-2 overflow-hidden w-full"><div class="dark:prose-light max-w-none p-3 prose"><h1>Command</h1> </div> </div> <div class="lg:w-4/5 order-4 overflow-hidden w-full"><div class="dark:prose-light max-w-3xl p-3 prose"><p>At any moment, you can get the avalaible command from symfony by typing <code>php bin/console list</code>. <p>Now, let's see what command we have and how useful there are. <p>The list above may vary depending on <a href=extensions>installed extensions</a> <p>To get more details on each command line, just type -h (eg <code>php bin/console pushword:user:create -h</code>) <pre><code class="shell"> pushword
   pushword:flat:import                       Syncing flat file inside database
   pushword:flat:export                       Export database toward file (yaml+json)
   pushword:image:cache                       Generate all images cache

diff --git a/docs/component/entity-filter.html b/docs/component/entity-filter.html
diff --git a/docs/configuration.html b/docs/configuration.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="bg-white dark:bg-gray-900 dark:text-gray-100 leading-tight overflow-x-hidden text-gray-900" lang=en><head><meta charset=UTF-8><meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name=viewport><link href=/assets/favicons/apple-touch-icon.png rel=apple-touch-icon sizes=180x180><link href=/assets/favicons/favicon-32x32.png rel=icon sizes=32x32 type=image/png><link href=/assets/favicons/favicon-16x16.png rel=icon sizes=16x16 type=image/png><link href=/assets/favicons/site.webmanifest rel=manifest><link color=#000000 href=/assets/favicons/safari-pinned-tab.svg rel=mask-icon><link href=/assets/favicons/favicon.ico rel="shortcut icon"><meta content=Pushword name=apple-mobile-web-app-title><meta content=Pushword name=application-name><meta content=#fff name=msapplication-TileColor><meta content=/assets/favicons/browserconfig.xml name=msapplication-config><meta content=#fff name=theme-color><title>	Configure a fresh install of Pushword </title><link href=/assets/tw.min.css?7f18cf710 rel=stylesheet><style>:root{--primary:#ef8206;--secondary:#d97706;--font-family:Inter var,ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol}</style><style>.nojs{display:inline-block}</style><script>document.head.insertAdjacentHTML('beforeend','<style>.nojs{display:none !important}<\/style>')</script><link href=https://pushword.piedweb.com/feed.xml rel=alternate title="Pushword &raquo; Flux" type=application/rss+xml><link href=https://pushword.piedweb.com/configuration rel=canonical><link href=https://pushword.piedweb.com/configuration hreflang=x-default rel=alternate><meta content="Configure a fresh install of Pushword" name=og:title><meta content=https://pushword.piedweb.com/configuration name=og:url><meta content=/media/og/configuration-7d96b8.png name=og:image><script>const base="/"</script> <body><div class="flex flex-col min-h-screen"><div class="flex flex-wrap items-stretch max-w-screen-2xl mx-auto" style=min-height:85vh><div class="lg:ml-0 lg:mr-0 lg:w-3/4 mx-auto order-2 w-full"><div class=pt-6></div> <nav aria-label=breadcrumb class="dark:text-gray-300 font-light p-3 text-gray-700 text-sm"><ol itemscope itemtype=https://schema.org/BreadcrumbList><li class=inline-block itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a class=hover:underline href=/ itemprop=item><span itemprop=name>Pushword</span></a> <meta content=1 itemprop=position> <span class="inline-block px-1">›</span> <li class=inline-block itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a class=hover:underline href=/installation itemprop=item><span itemprop=name>Installation</span></a> <meta content=2 itemprop=position></ol> </nav> <div class="flex flex-wrap max-w-5xl"><div class="lg:order-1 lg:w-4/5 order-2 overflow-hidden w-full"><div class="dark:prose-light max-w-none p-3 prose"><h1>Configuration</h1> <p>Before to <strong>code</strong>, Pushword offers the ability to configure a lot of things from a <strong>yaml</strong> (or PHP if you preferred) configuration file. <p>If you used the <a href="/installation">automatic installer</a> to create a new <em>pushword project</em>, just open <code>config/packages/pushword.yaml</code> and start configure your <strong>website</strong>. <p><span bg-primary text-white>Good to remember</span> In the configuration a <code>website</code> has a more generic name, it's an <code>app</code> <p>When you create a new <em>pushword project</em> important property to configure now is <strong>host</strong> (eg: <code>host: localhost.dev</code>). Then you are ready to use your website.</div> </div> <div class="lg:order-2 lg:w-1/5 order-3 overflow-hidden w-full"><div class="lg:absolute lg:border-gray-200 lg:border-l lg:max-w-xs m-2 max-w-screen-sm p-3 pt-4 rounded"><h3 class="block dark:text-gray-100 font-semibold lg:mb-3 lg:text-xs mb-3 px-1 text-gray-900 text-sm tracking-wide uppercase">Contents</h3> <div class="-ml-6 dark:prose-light max-w-none prose-sm px-1"><ul><li class=first><a href=#configuration-types>Two levels : Global vs App</a> <ul class=menu_level_1><li class=first><a href=#how-to-difference-global-from-app-configuration-without-reading-the-docs>How to difference global from app configuration without reading the docs ?</a> <li class=last><a href=#dump>How to get all configuration property without reading the docs ?</a> </ul> <li><a href=#can-i-add-an-custom-app-configuration-property-that-i-will-be-able-to-use-in-my-custom-code>Can I add an custom app configuration property that I will be able to use in my custom code ?</a> <li><a href=#configuration-settings>Configuration Settings</a> <li class=last><a href=#focus-on-the-app-property>Focus on the app property</a> </ul> </div></div> </div> <div class="lg:w-4/5 order-4 overflow-hidden w-full"><div class="dark:prose-light max-w-3xl p-3 prose"><h2 id=configuration-types>Two levels : <code>Global</code> vs <code>App</code></h2> <p>Before to digg in your configuration file, you need to know there is two different config properties : the <code>global</code> ones and the <code>app</code> ones. <p>This specificity is the same for almost all officially maintained pushword extensions. <p>If you want the same configure value for all <code>app</code>, you can configure globally and the value will be transmit to each app config. <h3 id=how-to-difference-global-from-app-configuration-without-reading-the-docs>How to difference global from app configuration without reading the docs ?</h3> <p>At the begining of each configuration's file (if you do <a href="#dump">a fresh dump</a>), you will find a property named <code>app_fallback_properties</code>. <p>This one define the <strong>app</strong> configuration. <h3 id=dump>How to get all configuration property without reading the docs ?</h3> <pre><code class="shell">php bin/console config:dump-reference PushwordCoreBundle
+<!DOCTYPE html><html class="bg-white dark:bg-gray-900 dark:text-gray-100 leading-tight overflow-x-hidden text-gray-900" lang=en><head><meta charset=UTF-8><meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name=viewport><link href=/assets/favicons/apple-touch-icon.png rel=apple-touch-icon sizes=180x180><link href=/assets/favicons/favicon-32x32.png rel=icon sizes=32x32 type=image/png><link href=/assets/favicons/favicon-16x16.png rel=icon sizes=16x16 type=image/png><link href=/assets/favicons/site.webmanifest rel=manifest><link color=#000000 href=/assets/favicons/safari-pinned-tab.svg rel=mask-icon><link href=/assets/favicons/favicon.ico rel="shortcut icon"><meta content=Pushword name=apple-mobile-web-app-title><meta content=Pushword name=application-name><meta content=#fff name=msapplication-TileColor><meta content=/assets/favicons/browserconfig.xml name=msapplication-config><meta content=#fff name=theme-color><title>	Configure a fresh install of Pushword </title><link href=/assets/tw.min.css?7f18cf710 rel=stylesheet><style>:root{--primary:#ef8206;--secondary:#d97706;--font-family:Inter var,ui-sans-serif,system-ui,-apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Helvetica Neue,Arial,Noto Sans,sans-serif,Apple Color Emoji,Segoe UI Emoji,Segoe UI Symbol}</style><style>.nojs{display:inline-block}</style><script>document.head.insertAdjacentHTML('beforeend','<style>.nojs{display:none !important}<\/style>')</script><link href=https://pushword.piedweb.com/feed.xml rel=alternate title="Pushword &raquo; Flux" type=application/rss+xml><link href=https://pushword.piedweb.com/configuration rel=canonical><link href=https://pushword.piedweb.com/configuration hreflang=x-default rel=alternate><meta content="Configure a fresh install of Pushword" name=og:title><meta content=https://pushword.piedweb.com/configuration name=og:url><meta content=https://pushword.piedweb.com/media/og/configuration-7d96b8.png name=og:image><script>const base="/"</script> <body><div class="flex flex-col min-h-screen"><div class="flex flex-wrap items-stretch max-w-screen-2xl mx-auto" style=min-height:85vh><div class="lg:ml-0 lg:mr-0 lg:w-3/4 mx-auto order-2 w-full"><div class=pt-6></div> <nav aria-label=breadcrumb class="dark:text-gray-300 font-light p-3 text-gray-700 text-sm"><ol itemscope itemtype=https://schema.org/BreadcrumbList><li class=inline-block itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a class=hover:underline href=/ itemprop=item><span itemprop=name>Pushword</span></a> <meta content=1 itemprop=position> <span class="inline-block px-1">›</span> <li class=inline-block itemprop=itemListElement itemscope itemtype=https://schema.org/ListItem><a class=hover:underline href=/installation itemprop=item><span itemprop=name>Installation</span></a> <meta content=2 itemprop=position></ol> </nav> <div class="flex flex-wrap max-w-5xl"><div class="lg:order-1 lg:w-4/5 order-2 overflow-hidden w-full"><div class="dark:prose-light max-w-none p-3 prose"><h1>Configuration</h1> <p>Before to <strong>code</strong>, Pushword offers the ability to configure a lot of things from a <strong>yaml</strong> (or PHP if you preferred) configuration file. <p>If you used the <a href="/installation">automatic installer</a> to create a new <em>pushword project</em>, just open <code>config/packages/pushword.yaml</code> and start configure your <strong>website</strong>. <p><span bg-primary text-white>Good to remember</span> In the configuration a <code>website</code> has a more generic name, it's an <code>app</code> <p>When you create a new <em>pushword project</em> important property to configure now is <strong>host</strong> (eg: <code>host: localhost.dev</code>). Then you are ready to use your website.</div> </div> <div class="lg:order-2 lg:w-1/5 order-3 overflow-hidden w-full"><div class="lg:absolute lg:border-gray-200 lg:border-l lg:max-w-xs m-2 max-w-screen-sm p-3 pt-4 rounded"><h3 class="block dark:text-gray-100 font-semibold lg:mb-3 lg:text-xs mb-3 px-1 text-gray-900 text-sm tracking-wide uppercase">Contents</h3> <div class="-ml-6 dark:prose-light max-w-none prose-sm px-1"><ul><li class=first><a href=#configuration-types>Two levels : Global vs App</a> <ul class=menu_level_1><li class=first><a href=#how-to-difference-global-from-app-configuration-without-reading-the-docs>How to difference global from app configuration without reading the docs ?</a> <li class=last><a href=#dump>How to get all configuration property without reading the docs ?</a> </ul> <li><a href=#can-i-add-an-custom-app-configuration-property-that-i-will-be-able-to-use-in-my-custom-code>Can I add an custom app configuration property that I will be able to use in my custom code ?</a> <li><a href=#configuration-settings>Configuration Settings</a> <li class=last><a href=#focus-on-the-app-property>Focus on the app property</a> </ul> </div></div> </div> <div class="lg:w-4/5 order-4 overflow-hidden w-full"><div class="dark:prose-light max-w-3xl p-3 prose"><h2 id=configuration-types>Two levels : <code>Global</code> vs <code>App</code></h2> <p>Before to digg in your configuration file, you need to know there is two different config properties : the <code>global</code> ones and the <code>app</code> ones. <p>This specificity is the same for almost all officially maintained pushword extensions. <p>If you want the same configure value for all <code>app</code>, you can configure globally and the value will be transmit to each app config. <h3 id=how-to-difference-global-from-app-configuration-without-reading-the-docs>How to difference global from app configuration without reading the docs ?</h3> <p>At the begining of each configuration's file (if you do <a href="#dump">a fresh dump</a>), you will find a property named <code>app_fallback_properties</code>. <p>This one define the <strong>app</strong> configuration. <h3 id=dump>How to get all configuration property without reading the docs ?</h3> <pre><code class="shell">php bin/console config:dump-reference PushwordCoreBundle
 </code></pre> <p><span bg-primary="" text-white="">Good to remember</span> for each <em>Pushword Projet</em>, you have a lot of different extension, you may find the good configuration property in the concerned extension. <p>For example, to get the admin configuration option <pre><code class="shell">php bin/console config:dump-reference PushwordAdminBundle
 # or php bin/console config:dump-reference pushword_admin
 </code></pre> <h2 id=can-i-add-an-custom-app-configuration-property-that-i-will-be-able-to-use-in-my-custom-code>Can I add an custom app configuration property that I will be able to use in my custom code ?</h2> <p>Yes and no ! <p>No because tanks to the <strong>Symfony Configuration Component</strong>, the configuration file is verified before to be used. <p>And yes, because we want to create quickly a prototype or a POC, so Pushword add a special <code>custom_properties</code> under wich you can set the property you want. <h2 id=configuration-settings>Configuration Settings</h2> <p>So remember, we are in the <code>config/packages/pushword.yaml</code> and this is a dump for the file with all properties. <p><strong>If you don't understand what the purpose of a property property. Feel free to ask (github or mail), I will list answers on this page.</strong> <pre><code>pushword: