Documentation improvements: Audit Trail/Redis/SEO/Deployment docs, demo videos, YouTube embed privacy (Lombiq Technologies: OCORE-78) #11154
Conversation
This file contains 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
Member
Piedone
commented
Feb 10, 2022
•
Piedone
commented
- Typos and formatting fixes
- Audit Trail module docs, fixes Document Audit Trail #10097
- Redis module docs
- SEO module docs
- Adding missing demo videos
- Videos are embedded with the YouTube privacy-enhanced mode
- Improving docs contribution docs
Piedone
changed the title
Piedone
changed the title
hishamco
requested changes
Feb 10, 2022
Piedone
commented
Feb 10, 2022
| @@ -375,7 +374,7 @@ When rendering the scripts the resource manager will order the output based on t | |||
| 3. `bar` | |||
|
|
|||
| !!! note | |||
| You do not have to define a name for your script or style unless you want to reference it as a dependency, or declare it as `Inline`. | |||
| You do not have to define a name for your script or style unless you want to reference it as a dependency, or declare it as `Inline`. Hence why the above inline examples all include a name. | |||
Piedone
changed the title
Piedone
commented
Feb 10, 2022
|
|
||
| You can attach the `AuditTrailPart` content part to your content type. This will allow content editors to enter a comment to be saved into the Audit Trail event when saving a content item. This will then be visible in the Audit Trail event list. | ||
|
|
||
| ## Recording Custom Events |
There was a problem hiding this comment.
I've removed the long tutorial that was previously added to the file under #10097. It would need extensive update to reflect the current API and while it would be nice to have such a tutorial, it's also a pain to maintain, and in the light of living examples being available in the source code I don't see the real point.
hishamco
requested changes
Feb 14, 2022
hishamco
approved these changes
Feb 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.