Skip to content
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

Docs #548

Merged
merged 30 commits into from
May 24, 2024
Merged

Docs #548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
330 changes: 80 additions & 250 deletions docs/advanced/advanced01.rst

Large diffs are not rendered by default.

360 changes: 181 additions & 179 deletions docs/advanced/advanced02.rst

Large diffs are not rendered by default.

Binary file added docs/advanced/img/A01/after.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A01/before.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A01/css_demo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A01/custom_css.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A01/custom_navbar.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A01/logo_centered.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A01/navbar_html.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A02/plp_as_child.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A02/plp_editor.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A02/plp_preview.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A02/pp_editor.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A02/pp_preview.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/advanced/img/A02/pp_preview2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/advanced/img/advanced_customcss1.png
Binary file not shown.
Binary file removed docs/advanced/img/advanced_footer_front.png
Binary file not shown.
Binary file not shown.
Binary file removed docs/advanced/img/advanced_improved_website1.png
Binary file not shown.
Binary file removed docs/advanced/img/advanced_two_tiered_navbar.png
Binary file not shown.
Binary file removed docs/advanced/img/cupcake_landing_published.png
Binary file not shown.
Binary file removed docs/advanced/img/cupcake_page_published.png
Binary file not shown.
10 changes: 5 additions & 5 deletions docs/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -302,21 +302,21 @@ Output will be in ``docs/_build/html/`` directory.
Updating Tutorial Documentation
-------------------------------

From time to time, the documentation for the tutorial will need to be updated. You can work directly in
the tutorial site by loading the fixture file for its database (read more at :ref:`load-data`).
.. From time to time, the documentation for the tutorial will need to be updated. You can work directly in
.. the tutorial site by loading the fixture file for its database (read more at :ref:`load-data`).

However, once you have worked in the tutorial site and gotten new screenshots for the **Getting Started** documentation,
you will also need to update the fixture file, which is located in ``tutorial > mysite > website > fixtures``.
you will also need to update the fixture file, which is located in ``tutorial > mysite > website > fixtures``.

**These are the steps for updating the fixture:**

1. From the command line, type ``python manage.py dumpdata --natural-foreign --natural-primary -e contenttypes -e auth.Permission --indent 4 > dumpdata.json``

2. The dumped data file will show up in the ``website`` folder. Open it and copy/paste its contents into a new file called ``database.json``. This will fix the encoding issue you would run into otherwise. Save the new fixture file and delete the one that was dumped. Also delete the one that is currently in the ``fixtures`` folder.

3. Move the ``database.json`` file into the ``fixtures`` folder.
3. Move the ``database.json`` file into the ``fixtures`` folder.

4. For testing ``loaddata``, please review the steps at :ref:`load-data`.
.. 4. For testing ``loaddata``, please review the steps at :ref:`load-data`.


Publishing a New Release
Expand Down
11 changes: 0 additions & 11 deletions docs/features/blocks/contentblocks/accordion.rst

This file was deleted.

32 changes: 0 additions & 32 deletions docs/features/blocks/contentblocks/carousel.rst

This file was deleted.

19 changes: 0 additions & 19 deletions docs/features/blocks/contentblocks/image.rst

This file was deleted.

43 changes: 0 additions & 43 deletions docs/features/blocks/contentblocks/imagegallery.rst

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Binary file removed docs/features/blocks/contentblocks/img/textblock.png
Diff not rendered.
32 changes: 0 additions & 32 deletions docs/features/blocks/contentblocks/latestpages.rst

This file was deleted.

19 changes: 0 additions & 19 deletions docs/features/blocks/contentblocks/pagepreview.rst

This file was deleted.

13 changes: 0 additions & 13 deletions docs/features/blocks/index.rst

This file was deleted.

35 changes: 0 additions & 35 deletions docs/features/blocks/layoutblocks/cardgrid.rst

This file was deleted.

Diff not rendered.
Diff not rendered.
Binary file removed docs/features/blocks/layoutblocks/img/hero_block.png
Diff not rendered.
Diff not rendered.
Diff not rendered.
46 changes: 46 additions & 0 deletions docs/features/contentblocks/accordion.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.. _accordion-block:

Accordion Block
===============

Creates a collapsible section with a button to toggle.
Each Accordion has multiple sections or panels.

`View example live <https://crxpharma.codered.cloud/demo-blocks/accordion-block/>`_


Example:

.. figure:: images/accordion_closed.jpeg
:alt: demo accordion closed

Demo accordion closed

.. figure:: images/accordion_open.jpeg
:alt: demo accordion with panel open

Demo accordion with panel open

Field Reference
---------------

Fields and purposes:

* **Accordion** - Choose a preexisting accordion snippet, created under snippets.

Editor:

.. figure:: images/accordion_demo.jpeg
:alt: Editing screen for accordion

Editing screen for accordion

Each Accordion panel needs a name and content. After you make a second panel,
arrows will appear to allow you to change the order of the panels.

.. figure:: images/accordion_arrows.jpeg
:alt: arrows on the accordion panels

Arrows on the accordion panels. They appear after you make a second panel.

Additional Information in the `bootstrap docs <https://getbootstrap.com/docs/5.2/components/accordion/>`_
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ Button Block
The button block renders an HTML anchor styled as a button. This can be used to
link to pages, documents, or external links.

Example:

.. figure:: images/button_example.jpeg
:alt: default button styles

default button styles

Note this screen shot was taken using the default bootstrap colors. If you use a theme or change global colors with sass,
they will likely be different colors.

Field Reference
---------------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
.. _card-block:

Card Block
==========

Allows the user to fill out information to be displayed in a card. Crops the image to a 3:2 ratio.
Allows the user to fill out information to be displayed in a card. Crops the image to a 3:2 ratio.

.. note::
There is also a :ref:`card-grid` which groups cards into a grid and is a Layout Block;
There is also a :ref:`card-grid` which groups cards into a grid and is a Layout Block;
this Card Block only displays a single card.

Example: See below.

Field Reference
---------------

Expand All @@ -22,5 +26,14 @@ Fields and purposes:

* **Links > Button Link** - The button link to include at the bottom of the card, set to link to a page or external link

* **Advanced Settings > Template** - Multiple options for Card layouts. See Below for reference.

Here is the same card, using different templates in the advanced settings:

.. figure:: images/card_layout_options.jpeg
:alt: Grid of a card with different layout templates selected

A Grid of a card with different layout templates selected.

Explore `Bootstrap Cards <https://getbootstrap.com/docs/4.0/components/card/>`_ to get an understanding of the
appearance and function of cards.
appearance and function of cards.
Loading
Loading