-
-
Notifications
You must be signed in to change notification settings - Fork 190
Add Plone dependency diagram and documentation references #2021
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b194669
Add images to index.md
jyotimahato-12 3546f91
Add Plone dependency diagram and documentation references
jyotimahato-12 6de078c
Add Plone dependency diagram and documentation references
jyotimahato-12 7b16a3a
Remove unnecessary file docs/overview/index.md from PR
jyotimahato-12 4dfa6c2
Add Plone dependency diagram and documentation references
jyotimahato-12 2a7d442
Add Plone dependency visualization to Overview
jyotimahato-12 4fc6000
Revert "add more info"
jyotimahato-12 aae0772
Remove dependency diagram from index.md and keep overview/index.md
jyotimahato-12 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
|
|
||
| --- | ||
| myst: | ||
| html_meta: | ||
|
|
@@ -154,4 +155,4 @@ genindex | |
| :hidden: true | ||
|
|
||
| training/index | ||
| ``` | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # Icons in Plone 6 Classic UI | ||
|
|
||
| - Bootstrap Icons | ||
| - SVG Inline Icons | ||
| - Iconresolver | ||
|
|
||
|
|
||
| # Bootstrap Icons | ||
|
|
||
| Bootstrap is the default CSS Framework in Plone 6. We decided to use it's icons as well. Check out all available Icons: | ||
|
|
||
| https://icons.getbootstrap.com/ | ||
|
|
||
| Icons are shipped via plone.staticresources. Check out the [package.json](https://github.com/plone/plone.staticresources/blob/master/package.json) of the package to get the actual version of the icons in Plone. | ||
|
|
||
|
|
||
| # Registration | ||
|
|
||
| * Icons are registered in Plone's registry | ||
| * Override of icons via xml | ||
| * [Bootstrap Icons](https://github.com/plone/plone.staticresources/blob/master/src/plone/staticresources/profiles/default/registry/icons_bootstrap.xml) | ||
| * [Contenttypes](https://github.com/plone/plone.staticresources/blob/master/src/plone/staticresources/profiles/default/registry/icons_contenttype.xml) | ||
| * [Plone UI](https://github.com/plone/plone.staticresources/blob/master/src/plone/staticresources/profiles/default/registry/icons_plone.xml) | ||
|
|
||
|
|
||
| # Customization | ||
|
|
||
| * Add custom icons | ||
| * Override some of the icons | ||
| * TODO | ||
|
|
||
|
|
||
| # Icon Font | ||
|
|
||
| * TODO | ||
| * Setup profile to install icon font | ||
| * Usage as known from e.g. Font Awesome | ||
|
|
||
|
|
||
| # Iconresolver | ||
|
|
||
| ## Get Icon URL | ||
|
|
||
| URL method of @@icons view returns the actual URL to the SVG icon. This can be used e.g. in an img tag. | ||
|
|
||
| ``` | ||
| <img src="" tal:attributes="src python:icons.url('alarm')" class="custom-class" alt="foo" /> | ||
| ``` | ||
|
|
||
| ## Get Icon Tag | ||
|
|
||
| Tag method is used with tal:replace and returns an entire inline SVG image. tag_class and tag_alt is used to pass in custom classes and an alt text. | ||
|
|
||
| ``` | ||
| <tal:icon tal:replace="structure python:icons.tag('archive', tag_class='custom-class', tag_alt='foobar')" /> | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| --- | ||
| myst: | ||
| html_meta: | ||
| "description": "This website is the documentation of Plone, an open source, enterprise-level content management system." | ||
| "property=og:description": "This website is the documentation of Plone, an open source, enterprise-level content management system." | ||
| "property=og:title": "Plone 6 Documentation" | ||
| "keywords": "Plone 6, content management system, CMS, open source, Documentation, Volto, Classic UI, frontend, backend, plone.restapi, plone.api" | ||
| --- | ||
|
|
||
| (index-label)= | ||
|
|
||
| # Plone 6 Documentation | ||
|
|
||
| This is the community-maintained documentation for the Plone content management system. | ||
|
|
||
| `````{grid} 1 1 2 2 | ||
| :gutter: 3 3 4 5 | ||
|
|
||
| ````{grid-item-card} | ||
| :link: install/index | ||
| :link-type: doc | ||
| {octicon}`zap;1.5em;sd-text-info` | ||
| Get started | ||
| ^^^ | ||
| This part of the documentation describes how to get started with Plone. | ||
| Choose from trying a demo of Plone or installing Plone. | ||
| +++ | ||
| ```{button-ref} install/index | ||
| :color: primary | ||
| :expand: | ||
| Go to Get started | ||
| ``` | ||
| ```` | ||
|
|
||
| ````{grid-item-card} | ||
| :link: user-guide/index | ||
| :link-type: doc | ||
| {octicon}`person;1.5em;sd-text-info` | ||
| User guide | ||
| ^^^ | ||
| This part of the documentation describes how to use Plone effectively, covering tasks for site editors and administrators. | ||
| +++ | ||
| ```{button-ref} user-guide/index | ||
| :ref-type: doc | ||
| :color: primary | ||
| :expand: | ||
| Go to User guide | ||
| ``` | ||
| ```` | ||
|
|
||
| ````{grid-item-card} | ||
| :link: developer-guide/index | ||
| :link-type: doc | ||
| {octicon}`person-add;1.5em;sd-text-info` | ||
| Developer guide | ||
| ^^^ | ||
| This part of the documentation describes how to develop a Plone project. | ||
| +++ | ||
| ```{button-ref} developer-guide/index | ||
| :ref-type: doc | ||
| :color: primary | ||
| :expand: | ||
| Go to Developer guide | ||
| ``` | ||
| ```` | ||
|
|
||
| ````{grid-item-card} | ||
| :link: reference-guide/index | ||
| :link-type: doc | ||
| {octicon}`bookmark;1.5em;sd-text-info` | ||
| Reference guide | ||
| ^^^ | ||
| This part of the documentation describes the APIs, functions, modules, and objects included in Plone. | ||
| +++ | ||
| ```{button-ref} reference-guide/index | ||
| :ref-type: doc | ||
| :color: primary | ||
| :expand: | ||
| Go to Reference guide | ||
| ``` | ||
| ```` | ||
|
|
||
| ````{grid-item-card} | ||
| :link: conceptual-guides/index | ||
| :link-type: doc | ||
| {octicon}`light-bulb;1.5em;sd-text-info` | ||
| Conceptual guides | ||
| ^^^ | ||
| This part of the documentation provides explanation of concepts to deepen and broaden your understanding of Plone. | ||
| +++ | ||
| ```{button-ref} conceptual-guides/index | ||
| :ref-type: doc | ||
| :color: primary | ||
| :expand: | ||
| Go to Conceptual guides | ||
| ``` | ||
| ```` | ||
|
|
||
| ````{grid-item-card} | ||
| :link: contributing/index | ||
| :link-type: doc | ||
| {octicon}`git-pull-request;1.5em;sd-text-info` | ||
| Contributor guide | ||
| ^^^ | ||
| This part of the documentation describes how to contribute to Plone, including all its projects and repositories under the Plone GitHub organization. | ||
| +++ | ||
| ```{button-ref} contributing/index | ||
| :ref-type: doc | ||
| :color: primary | ||
| :expand: | ||
| Go to Contributor guide | ||
| ``` | ||
| ```` | ||
|
|
||
| ````` | ||
|
|
||
| ```{seealso} | ||
| Read the [documentation for the previous version, Plone 5](https://5.docs.plone.org/). | ||
| ``` | ||
|
|
||
|
|
||
| ```{toctree} | ||
| :maxdepth: 2 | ||
| :hidden: true | ||
|
|
||
| overview/index | ||
| install/index | ||
| admin-guide/index | ||
| developer-guide/index | ||
| deployment/index | ||
| volto/index | ||
| classic-ui/index | ||
| plone.restapi/docs/source/index | ||
| backend/index | ||
| i18n-l10n/index | ||
| conceptual-guides/index | ||
| contributing/index | ||
| reference-guide/index | ||
| user-guide/index | ||
| ``` | ||
|
|
||
| ```{toctree} | ||
| :caption: Appendices | ||
| :maxdepth: 1 | ||
| :hidden: true | ||
|
|
||
| glossary | ||
| genindex | ||
| ``` | ||
|
|
||
| ```{toctree} | ||
| :caption: Tutorials | ||
| :maxdepth: 1 | ||
| :hidden: true | ||
|
|
||
| training/index | ||
| ``` | ||
| ## Dependency Diagram | ||
|
|
||
|  | ||
|  | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Plone Classic UI Theming based on Barceloneta | ||
|
|
||
| * TODO | ||
| * SCSS | ||
| * Colors, fonts and sizes via variable changable | ||
| * Properties for shadows, rounded corners, gradients, etc. | ||
| * plonetheme.barceloneta npm package for includes | ||
| * bobtemplates.plone template |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Plone Classic UI Theme Add-On | ||
|
|
||
| Create a filesystem package to keep an installable theme for Plone 6 Classic UI. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file should not be added. It's in the wrong place, and we already have
docs/index.md.