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

add cache docs #172

Merged
merged 18 commits into from
Mar 5, 2024
Merged

add cache docs #172

merged 18 commits into from
Mar 5, 2024

Conversation

fakela
Copy link
Member

@fakela fakela commented Jan 21, 2024

@RCheesley i have moved the cache docs to this PR: #148

link_text = "Symfony Cache Component"
link_url = "https://symfony.com/doc/current/components/cache.html"

link.xref_links.update({link_name: (link_text, link_url)})
Copy link
Contributor

Choose a reason for hiding this comment

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

no new line

Copy link
Member

Choose a reason for hiding this comment

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

These files are created automatically using the make link command, so I think we are OK to leave as they are :)

fakela and others added 2 commits February 12, 2024 15:34
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Rohit Joshi <joshi.rohit100@gmail.com>
@fakela
Copy link
Member Author

fakela commented Feb 12, 2024

@RCheesley I have gone through the comments; please check if this is good to go.

Vale is throwing an error but it's highlighting words that are in the code block

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

Quite a lot of changes @fakela - please make sure you are working on these PRs using VSCode / Gitpod or at least running the linting in your IDE. Many of these were clearly flagged up as errors when I opened the PR in Gitpod.

The most common issues:

  • Code blocks must have a single line break after the directive and before the code
  • Code blocks must have a single line break after the code and before the following text

This should then fix some of the issues with the linter trying to parse the code blocks - because the markup wasn't correct it just sees them as regular text.

docs/components/cache.rst Show resolved Hide resolved
docs/components/cache.rst Outdated Show resolved Hide resolved
docs/components/cache.rst Outdated Show resolved Hide resolved
docs/components/cache.rst Show resolved Hide resolved
docs/components/cache.rst Show resolved Hide resolved
docs/components/cache.rst Show resolved Hide resolved
docs/components/cache.rst Show resolved Hide resolved
docs/components/cache.rst Show resolved Hide resolved
docs/components/cache.rst Outdated Show resolved Hide resolved
docs/components/cache.rst Show resolved Hide resolved
@fakela
Copy link
Member Author

fakela commented Feb 16, 2024

Quite a lot of changes @fakela - please make sure you are working on these PRs using VSCode / Gitpod or at least running the linting in your IDE. Many of these were clearly flagged up as errors when I opened the PR in Gitpod.

The most common issues:

  • Code blocks must have a single line break after the directive and before the code
  • Code blocks must have a single line break after the code and before the following text

This should then fix some of the issues with the linter trying to parse the code blocks - because the markup wasn't correct it just sees them as regular text.

Would run it on Gitpod now

fakela and others added 14 commits February 16, 2024 09:41
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
@fakela
Copy link
Member Author

fakela commented Mar 4, 2024

All checks passed @RCheesley

@RCheesley
Copy link
Member

All good, just need developer review! @escopecz could you review?

Copy link
Member

@escopecz escopecz left a comment

Choose a reason for hiding this comment

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

I see no issue 👍

@RCheesley RCheesley merged commit da1402b into mautic:5.x Mar 5, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants