Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 9 additions & 9 deletions docs/topics/advanced-usage.topic
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<chapter title="Root element" id="root_element">
<tip>
<p>
By defending, the name of the root element is formed from the basic name of the feed class.
By default, the name of the root element is derived from the base name of the feed class.
</p>

<p>
Expand All @@ -44,7 +44,7 @@
<code-block lang="php" src="advanced-element-root.php" include-lines="5-" />

<p>
To disable the addition of the main element, specify its name as empty - <code>null</code> or
To disable the addition of the root element, specify its name as empty <code>null</code> or
<code>""</code>.
</p>

Expand All @@ -59,7 +59,7 @@
<p>
To add information to the beginning of the root element (if present) or without it,
override the
<code>info</code> method in the feed class and call the creation of an object that extend the
<code>info</code> method in the feed class and create an object that extends the
<code>DragonCode\LaravelFeed\Feeds\Info\FeedInfo</code> class:
</p>

Expand All @@ -73,7 +73,7 @@
<code-block lang="xml" src="advanced-element-info.xml" />

<p>
If it is necessary to change the procedure for the output of the root element relative to the
If you need to change the order in which the root element is output relative to the
information block, set the <code>beforeInfo</code> parameter in the <code>root</code> method:
</p>

Expand Down Expand Up @@ -135,7 +135,7 @@
<link-summary>Indicates the applicable value "as it is"</link-summary>

<tip>
Note, that the value of the <code>@value</code> field must be a string.
Note that the value of the <code>@value</code> field must be a string.
</tip>

<p>
Expand All @@ -152,7 +152,7 @@
</chapter>

<chapter title="@cdata" id="_cdata">
<link-summary>Allows the use of XML marking without transformation</link-summary>
<link-summary>Allows the use of XML markup without transformation</link-summary>

<tip>
It is also possible to wrap the value of a node into a CDATA section.
Expand All @@ -173,7 +173,7 @@
</chapter>

<chapter title="@mixed" id="_mixed">
<link-summary>Allows you to use XML marking directly into the structure of the document</link-summary>
<link-summary>Allows you to use XML markup directly within the structure of the document</link-summary>

<p>
To insert XML fragments “as is”, use the <code>@mixed</code> directive:
Expand Down Expand Up @@ -211,7 +211,7 @@

<chapter title="Location &amp; filename" id="location_and_filename">
<p>
By default, feeds will be stored in the <code>public</code> storage,
By default, feeds are stored in <code>public</code> storage,
and the file name will be automatically generated from the feed class name after
<code>App\Feeds\</code> in <code>kebab-case</code> format.
For example:
Expand All @@ -235,7 +235,7 @@

<chapter title="Chunk size" id="chunk_size">
<p>
Database queries use chunks, which are <code>1000</code> bytes by default.
Database queries use chunks, which are <code>1000</code> items by default.
You can change this by overriding the <code>chunkSize</code> method:
</p>

Expand Down
4 changes: 2 additions & 2 deletions docs/topics/contributions.topic
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<a href="https://www.php-fig.org/psr/psr-4/">PSR-4</a> autoloading standard.
</p>
<p>
To apply the formatting of the code style, follow the console command:
To apply code style formatting, run the following console command:
</p>
<code-block lang="bash">
composer style
Expand All @@ -52,7 +52,7 @@
</p>

<list>
<li>Participants will be tolerant of opposing views.</li>
<li>Participants should be tolerant of opposing views.</li>
<li>Participants must ensure that their language and actions are free of personal attacks and disparaging
personal remarks.
</li>
Expand Down
37 changes: 18 additions & 19 deletions docs/topics/create-feeds.topic
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Create feeds" id="create-feeds" help-id="make-feeds;create-feeds;feeds">

<link-summary>Instructions for creating and filling feed, feed items, and feed info classes</link-summary>
<card-summary>Instructions for creating and filling feed, feed items, and feed info classes</card-summary>
<web-summary>Instructions for creating and filling feed, feed items, and feed info classes</web-summary>
<link-summary>Instructions for creating and populating the feed, feed item, and feed info classes</link-summary>
<card-summary>Instructions for creating and populating the feed, feed item, and feed info classes</card-summary>
<web-summary>Instructions for creating and populating the feed, feed item, and feed info classes</web-summary>

<show-structure depth="3" />

Expand All @@ -19,7 +19,7 @@
<a href="https://www.jetbrains.com/phpstorm/">PhpStorm</a>.
</p>

<img src="laravel-idea.png" dark-src="laravel-idea_dark.png" alt="laravel idea" />
<img src="laravel-idea.png" dark-src="laravel-idea_dark.png" alt="Laravel Idea" />
</note>

<p>
Expand All @@ -35,65 +35,64 @@
</p>

<p>
Also, this console command can create classes of the element and information along with the feed class.
To do this, use <code>--item</code> and <code>--info</code> parameters.
This console command can also create the item and info classes along with the feed class.
To do this, use the <code>--item</code> and <code>--info</code> options.
</p>

<code-block lang="bash">
# Create a feed class and information class
# Create a feed class and info class
%command-make% --info

# Create a feed class and item class
%command-make% --item

# Create a feed class, item class and information class
# Create a feed class, item class, and info class
%command-make% --item --info
</code-block>

<p>
Shortcuts are also available:
</p>

<code-block lang="bash">
<code-block lang="bash">
# Create a feed class and item class
%command-make% -%command-shortcut-item%

# Create a feed class and info class
%command-make% -%command-shortcut-info%

# Create a feed class, item class and information class
# Create a feed class, item class, and info class
%command-make% -%command-shortcut-info%%command-shortcut-item%
</code-block>

<note>
<p>
When creating a feed, an operation/migration will also be created to add it to the database.
When creating a feed, an operation or a migration will also be created to add it to the database.
</p>

<p>
If the project uses the
If the project uses
<a href="https://deploy-operations.dragon-code.pro">
<format style="bold">Laravel Deploy Operations</format>
</a>
, then an operation class will be created, otherwise a migration class will be created.
</a>, then an operation class will be created; otherwise, a migration class will be created.
</p>

<p>
This is necessary to add and manage information about feeds in the database.
This is required to add and manage feed information in the database.
</p>
</note>

<chapter title="Filling feeds" id="fill_feeds">
<chapter title="Populating feeds" id="fill_feeds">
<chapter title="Feed" id="feed">
<p>
Fill in the main feed class. For example:
Populate the main feed class. For example:
</p>

<code-block lang="php" src="create-feeds-feed.php" include-lines="5-" />

<chapter title="Feed Item" id="feed_item">
<chapter title="Feed item" id="feed_item">
<p>
Fill in the feed item class. For example:
Populate the feed item class. For example:
</p>

<code-block lang="php" src="generation-feed-item.php" include-lines="5-" />
Expand Down
6 changes: 3 additions & 3 deletions docs/topics/generation.topic
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
</code-block>

<p>
As a result, all active feeds (<code>is_active = true</code>) will be launched from the
As a result, all active feeds (<code>is_active = true</code>) will be executed from the
<code>feeds</code> table (or the one you specified in the <code>%config-filename%</code> file).
</p>

Expand All @@ -33,7 +33,7 @@
</p>

<p>
However, instead of being launched for execution, such feeds will be marked with the
However, instead of being executed, such feeds will be marked with the
<code>SKIP</code> status.
</p>
</tip>
Expand Down Expand Up @@ -68,7 +68,7 @@
<code-block lang="php" src="schedule-setup.php" include-lines="5-" />

<p>
This will enable you to register calls to all active feeds according to the launch schedule you specified in the
This will enable you to register calls to all active feeds according to the schedule you specified in the
<code>expression</code> column of the database.
</p>
</chapter>
Expand Down
3 changes: 1 addition & 2 deletions docs/topics/installation.topic
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@

<warning>
<p>
<format style="bold">Before running migrations</format>
, check the database connection settings in the
<format style="bold">Before running migrations</format>, check the database connection settings in the
<code>%config-filename%</code> file.
</p>
</warning>
Expand Down
2 changes: 1 addition & 1 deletion docs/topics/introduction.topic
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<title>📃 %instance%</title>

<description>
Easy and fast way of exporting a large amount of data to feeds for marketplaces and other consumers.
An easy and fast way to export large amounts of data to feeds for marketplaces and other consumers.
</description>

<spotlight>
Expand Down
6 changes: 3 additions & 3 deletions docs/topics/receipt-instagram.topic
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@

<show-structure depth="3" />

<chapter title="Create files" id="create_files">
<chapter title="Create the files" id="create_files">
<code-block lang="bash">
%command-make-simple% Instagram -%command-shortcut-item%
</code-block>
</chapter>

<chapter title="Filling the feed" id="filling_the_feed">
<chapter title="Populate the feed" id="filling_the_feed">
<code-block lang="php" src="receipt-instagram-feed.php" />
</chapter>

<chapter title="Filling the feed item" id="filling_the_feed_item">
<chapter title="Populate the feed item" id="filling_the_feed_item">
<code-block lang="php" src="receipt-instagram-feed-item.php" />
</chapter>

Expand Down
20 changes: 10 additions & 10 deletions docs/topics/receipt-sitemap.topic
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
title="Sitemap" id="receipt-sitemap" help-id="sitemap">

<link-summary>How to create a product sitemap feed</link-summary>
<card-summary>Step-by-step guide for creating a product sitemap</card-summary>
<card-summary>Step-by-step guide to creating a product sitemap</card-summary>
<web-summary>Step-by-step guide to creating a product sitemap feed</web-summary>

<show-structure depth="3" />
Expand All @@ -16,11 +16,11 @@
This recipe walks you through creating a product sitemap feed using Laravel Feeds. You will:
- Generate the necessary classes
- Implement the feed logic
- Expose the files via the filesystem
- Optionally reference the generated sitemap from a root sitemap.xml
- Expose the files via the file system
- Optionally reference the generated sitemap from a root sitemap.xml file
</p>

<chapter title="Create files" id="create_files">
<chapter title="Create the files" id="create_files">
<p>
Generate the feed and its item class using the following console command:
</p>
Expand All @@ -29,16 +29,16 @@
</code-block>
</chapter>

<chapter title="Fill the feed" id="filling_the_feed">
<chapter title="Populate the feed" id="filling_the_feed">
<p>
Implement the feed root element, attributes, query builder, output filename, and item mapping as shown below:
</p>
<code-block lang="php" src="receipt-sitemap-feed.php" />
</chapter>

<chapter title="Fill the feed item" id="filling_the_feed_item">
<chapter title="Populate the feed item" id="filling_the_feed_item">
<p>
Define the XML element name and map your model properties to the corresponding sitemap tags:
Define the XML element name and map your model’s properties to the corresponding sitemap tags:
</p>
<code-block lang="php" src="receipt-sitemap-feed-item.php" />
</chapter>
Expand All @@ -49,14 +49,14 @@

<chapter title="Links" id="links">
<p>
Add a filesystem disk that points to the directory containing your sitemaps in
Add a file system disk that points to the directory containing your sitemaps in
the <a href="https://github.com/laravel/laravel/blob/12.x/config/filesystems.php#L76-L78">config/filesystems.php</a> configuration file:
</p>

<code-block lang="php" src="receipt-sitemap-links.php" include-lines="5-" />

<p>
Then create the public symlink so the files are accessible in the browser:
Then create the public symlink so the files are accessible in a browser:
</p>

<code-block lang="bash">
Expand All @@ -77,7 +77,7 @@

<chapter title="Result" id="result">
<p>
A generated sitemap.xml for your products will look like this:
The generated sitemap.xml for your products will look like this:
</p>
<code-block lang="xml" src="receipt-sitemap-feed.xml" />
</chapter>
Expand Down
8 changes: 4 additions & 4 deletions docs/topics/receipt-yandex.topic
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@

<show-structure depth="3" />

<chapter title="Create files" id="create_files">
<chapter title="Create the files" id="create_files">
<code-block lang="bash">
%command-make-simple% Yandex -%command-shortcut-info%%command-shortcut-item%
</code-block>
</chapter>

<chapter title="Filling the feed" id="filling_the_feed">
<chapter title="Populate the feed" id="filling_the_feed">
<code-block lang="php" src="receipt-yandex-feed.php" />
</chapter>

<chapter title="Filling the feed info" id="filling_the_feed_info">
<chapter title="Populate the feed info" id="filling_the_feed_info">
<code-block lang="php" src="receipt-yandex-feed-info.php" />
</chapter>

<chapter title="Filling the feed item" id="filling_the_feed_item">
<chapter title="Populate the feed item" id="filling_the_feed_item">
<code-block lang="php" src="receipt-yandex-feed-item.php" />
</chapter>

Expand Down
2 changes: 1 addition & 1 deletion docs/topics/snippet-generate.topic
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
is-library="true"
id="snippet-generate"
title="Generate Command">
title="Generate command">

<snippet id="feed_generate">
<p>
Expand Down