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.

Sign up for GitHub

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

Jump to bottom

Change publish to available #251

Open
wants to merge 9 commits into
base: 5.x
Choose a base branch
from
+21 −21
Open

Change publish to available #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e2e195a
Update custom_fields.rst
andersonjeccel Mar 5, 2024
1f09c46
available
andersonjeccel May 8, 2024
1021252
Update docs/categories/categories-overview.rst
andersonjeccel Jun 14, 2024
d861fae
Update docs/components/assets.rst
andersonjeccel Jun 14, 2024
1d0f1ae
Update docs/components/assets.rst
andersonjeccel Jun 14, 2024
03aa03d
Update docs/components/assets.rst
andersonjeccel Jun 14, 2024
8a10a69
Update docs/components/forms.rst
andersonjeccel Jun 14, 2024
62f0dfd
Update docs/components/forms.rst
andersonjeccel Jun 14, 2024
88c334a
Merge branch '5.x' into change-publish-to-available-for-fields
RCheesley Nov 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/channels/sms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The following fields are available:

**Language** - This allows you to set the language of this Text Message.

**Published** - This allows you to set the published status of the Text Message. Unpublished Text Messages aren't sent.
**Available** - This allows you to set the availability status of the Text Message. Unavailable Text Messages aren't sent.

.. vale off

Expand All @@ -104,15 +104,15 @@ The following fields are available:

**Language** - This allows you to set the language of this Text Message.

**Published** - This allows you to set the published status of the Text Message. Unpublished Text Messages aren't sent.
**Available** - This allows you to set the availability status of the Text Message. Unavailable Text Messages aren't sent.

**Contact Segment** - This allows you to define the Segment/s who should receive the Text Message.

.. vale off

**Publish at (date/time)** - This allows you to define the date and time at which this Text Message is available for sending to Contacts
**Enable at (date/time)** - This allows you to define the date and time at which this Text Message is available for sending to Contacts
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise the SMS bundle doesn't yet have the option to enable/disable, maybe an upcoming feature?
screenshot-mautic ddev site-2024 06 13-15_35_55


**Unpublish at (date/time)** - This allows you to define the date and time at which this Text Message ceases to be available for sending to Contacts.
**Disable at (date/time)** - This allows you to define the date and time at which this Text Message ceases to be available for sending to Contacts.

Creating Text Messages from Campaign Builder
============================================
Expand Down
10 changes: 5 additions & 5 deletions docs/components/assets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Working with Assets

.. vale on

Before creating an Asset, first establish and publish any Categories required. It's not possible to assign Assets to unpublished Categories. If you wish to use an Integration such as the Amazon S3 Plugin to host your files, set this up before creating an Asset.
Before creating an Asset, first establish and create any Categories required. It's not possible to assign Assets to unavailable Categories. If you wish to use an Integration such as the Amazon S3 Plugin to host your files, set this up before creating an Asset.

.. vale off

Expand Down Expand Up @@ -77,13 +77,13 @@ The following fields are available:
- **Description** - an internally used description to inform other Mautic Users what the Asset is and/or where it's used.
- **Category** - used to organize resources - see :doc:`/categories/categories-overview` for more information
- **Language** - the language of this Asset - can be helpful in multilingual marketing Campaigns and for reporting purposes
- **Published** - Whether the Asset is available for use - published - or not available - unpublished
- **Available** - Whether the Asset is available for use or not available

.. vale off

**Publish at (date/time)** - This allows you to define the date and time at which this Asset is available
**Activate at (date/time)** - This allows you to define the date and time at which this Asset is available

**Unpublish at (date/time)** - This allows you to define the date and time at which this Asset ceases to be available
**Deactivate at (date/time)** - This allows you to define the date and time at which this Asset ceases to be available

.. vale on

Expand Down Expand Up @@ -141,7 +141,7 @@ Deleting an Asset
It's possible to delete an Asset by clicking on the 'delete' button while viewing the Asset, or by selecting the arrow next to the checkbox for the Asset, and selecting 'delete'. Mautic displays a confirmation screen, prompting confirmation that you wish to delete the Asset.

.. warning::
Once deleted, you can't retrieve an Asset, and statistics relating to the number of downloads for that Asset are no longer be available. Contact Points accumulated as a result of accessing the resource remain. It's recommended where possible to unpublish Assets which are no longer in use - in future there may be an archive feature.
Once deleted, you can't retrieve an Asset, and statistics relating to the number of downloads for that Asset are no longer be available. Contact Points accumulated as a result of accessing the resource remain. It's recommended where possible to deactivate Assets which are no longer in use - in future there may be an archive feature.

Display Assets directly in the browser
======================================
Expand Down
6 changes: 3 additions & 3 deletions docs/components/dynamic_web_content.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,17 @@ The following values are available:

- **Is a translation of** - If you're creating a slot in a second language translation - for example to use on a multilingual website - select the original base language Dynamic Web Content item which you're translating. The same slot displays the appropriate language based on the Campaign or filters set, but Mautic shows the translated content if a visitor is viewing the page in a different browser language.

- **Published** - Whether the Dynamic Web Content item is available for use - published - or not available - unpublished
- **Available** - Whether the Dynamic Web Content item is available for use or not available

- **Is Campaign based** - if set to Yes, Mautic pushes this Dynamic Web Content to Contacts through a Campaign. When set to No, you can specify filters for visitors to see the content.

- **Requested slot name** - shown if using non-Campaign based Dynamic Web Content, this allows you to specify the slot name on your website in which the Contact sees the content.

.. vale off

**Publish at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item is available for displaying to Contacts
**Enable at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item is available for displaying to Contacts
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Enable at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item is available for displaying to Contacts
**Enable at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item is available for displaying to Contacts

DWC doesn't actually have activate / deactivate date/times:

screenshot-mautic ddev site-2024 06 13-15_17_47

Maybe this is a feature we haven't yet got merged into core? cc @escopecz ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it was just copy-pasted from other entity docs. I'm not aware of any PR that's adding it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It’s probably there for months 🤣


**Unpublish at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item ceases to be available for displaying to Contacts.
**Disable at (date/time)** - This allows you to define the date and time at which this Dynamic Web Content item ceases to be available for displaying to Contacts.

.. vale on

Expand Down
8 changes: 4 additions & 4 deletions docs/components/forms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ The following fields are available:

- **Category** - Assign a Category to help you organize your Forms.

- **Published** - Whether the Form is available for use - published - or not available - unpublished. Unpublished Forms won't be visible when you've added the Form using JavaScript. If you used the manual method to copy and paste the Form HTML, the Form remains visible but visitors **won't** be able to submit it - an error message prevents them from submitting if they try to submit an unpublished Form.
- **Available** - Whether the Form is available for use or not available. Unavailable Forms won't be visible when you've added the Form using JavaScript. If you used the manual method to copy and paste the Form HTML, the Form remains visible but visitors **won't** be able to submit it - an error message prevents them from submitting if they try to submit an unavailable Form.

.. vale off

- **Publish at (date/time)** - This allows you to define the date and time at which this Form is available for submissions.
- **Activate at (date/time)** - This allows you to define the date and time at which this Form is available for submissions.

- **Unpublish at (date/time)** - This allows you to define the date and time at which this Form ceases to be available for submissions.
- **Deactivate at (date/time)** - This allows you to define the date and time at which this Form ceases to be available for submissions.

.. vale on

Expand Down Expand Up @@ -366,7 +366,7 @@ Typically you would use a Form action to populate static Segments - Segments whi

.. vale on

- **Download an Asset**: this option triggers an immediate download of the selected file when the Contact submits the Form. If you use Categories to organize your Assets, you can elect to have them download the most recently published Asset in a selected Category. If you prefer, you can link to a specific Asset.
- **Download an Asset**: this option triggers an immediate download of the selected file when the Contact submits the Form. If you use Categories to organize your Assets, you can elect to have them download the most recently enabled Asset in a selected Category. If you prefer, you can link to a specific Asset.

.. image:: images/forms/download_an_asset.png
:width: 600
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/cron_jobs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@

Starting with Mautic 2.2.0, it's now possible to use cron to send scheduled broadcasts for Channel communications. The current only implementation of this is for Segment Emails. Instead of requiring a manual send and wait with the browser window open while AJAX batches over the send, it's possible to use a command to initiate the process.

The caveat for this is that the Email must have a published up date and be currently published - this is to help prevent any unintentional Email broadcasts. Just as it was with the manual/AJAX process the message is only sent to Contacts who haven't already received the specific communication. This command sends messages to Contacts added to the source Segments later, so if you don't want this to happen, set an unpublish date.
The caveat for this is that the Email must have an enable date and be currently available - this is to help prevent any unintentional Email broadcasts. Just as it was with the manual/AJAX process the message is only sent to Contacts who haven't already received the specific communication. This command sends messages to Contacts added to the source Segments later, so if you don't want this to happen, set a disable date.

Check warning on line 257 in docs/configuration/cron_jobs.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.

Raw Output:
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.", "location": {"path": "docs/configuration/cron_jobs.rst", "range": {"start": {"line": 257, "column": 410}}}, "severity": "WARNING"}

.. code-block:: php

Expand Down
6 changes: 3 additions & 3 deletions docs/contacts/custom_fields.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@

* City

Published fields
Available fields
*****************

There is a toggle switch which shows before each label title. You can find this type of switch throughout the Mautic UI for publishing and unpublishing items.
Each label title is preceded by a toggle switch, commonly found across the Mautic UI, to toggle item availability.

Check warning on line 71 in docs/contacts/custom_fields.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is preceded').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is preceded').", "location": {"path": "docs/contacts/custom_fields.rst", "range": {"start": {"line": 71, "column": 18}}}, "severity": "INFO"}

.. only:: html

Expand Down Expand Up @@ -100,7 +100,7 @@

Since :xref:`Mautic 3` there is an option you can set in your ``app/config/local.php`` file: ``'create_custom_field_in_background' => true``,.

If you configure this option, the new Custom Field becomes visible in the list of Custom Fields. The Custom Field remains unpublished until you run the command ``bin/console mautic:custom-field:create-column``. This command creates the actual column in the table and publishes the field metadata.
If you configure this option, the new Custom Field becomes visible in the list of Custom Fields. The Custom Field remains unavailable for use until you run the command ``bin/console mautic:custom-field:create-column``. This command creates the actual column in the table and the field metadata.

This configuration helps prevent **http** request timeouts because it handles the long-running SQL query to create the new table column as a background task.

Expand Down
2 changes: 1 addition & 1 deletion docs/reports/reports.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The parent data source provides a high-level summary of the data while the child

* **Description - optional** - Add detailed information about the Report, helping you and other Users better understand what the Report is for. You may want to include more information about filters, people, or departments.

* **Published** - Select **Yes** to ensure that the Report is active, ready to send when scheduled in the Report options.
* **Available** - Select **Yes** to ensure that the Report is active, ready to send when scheduled in the Report options.

* **Visible for all logged-in Users** - Select **Yes** so that all Users can access the Report. If set to No, only the owner of the Report and Users with permission to view others' Reports can see the Report.

Expand Down
Loading