Added sitemap for collections & taxonomies #78

kevinmeijer97 · 2024-10-04T11:21:02Z

No description provided.

src/Commands/GenerateSitemap.php

BobWez98 · 2024-10-04T13:36:05Z

src/Commands/GenerateSitemap.php

+
+                return $terms
+                    ->filter(function ($term) {
+                        return view()->exists($term->template());


can't you check for a template in the query? It's a bit more efficient, also don't have to check the is not empty then

See #78 (comment)
Taxonomies are limited in the way we can check for urls, Statamic seems to be taking this approach themselves as well.

That's not what i'm saying, you can skip the whole ->filter() if you doe a ->where on the template in the query

No thats not possible, the template is not something we can query on. You can see why here https://github.com/statamic/cms/blob/5.x/src/Taxonomies/LocalizedTerm.php#L381

But in the taxonomy_terms table there is a uri column as with rapidez/statamic we require the Eloquent driver so with that we don't have to check for existing views? When the view doesn't exist that uri column should be empty according https://statamic.dev/taxonomies#routing, didn't test it.

Was just able to test it, unfortunately an existing uri column doesn't guarantee an existing view. It seems like as long as a term has a slug, the uri field will be filled.

This is probably also why Statamic does it this way themselves in their SEO addon.

Either way, still added the uri check in the query. Since all terms that do have views also do have uri's.

BobWez98 · 2024-10-04T13:41:57Z

src/Commands/GenerateSitemap.php

+    {
+        $sitemap = '<?xml version="1.0" encoding="UTF-8"?>';
+        $sitemap .= '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">';
+        $entries = $collection->queryEntries()->where('site', $site->handle())->whereStatus('published')->get();


We can have collections that have no route, like Category content, but have no url, how is this handled? I see no check on the ->url()

The collections that are queried are already filtered by collections that have urls, so collections like the category content won't come here

README.md

royduin

Is checking the view the right way? Can't we check if the collection/taxonomy has a route?

README.md

src/Commands/GenerateSitemap.php

kevinmeijer97 · 2024-10-08T09:28:43Z

Is checking the view the right way? Can't we check if the collection/taxonomy has a route?

Sadly we cant check routes on taxonomies the same way we can check routes on collections.
For the taxonomies this is also the way Statamic seems to do it for their sitemap in the SEO addon.

Co-authored-by: Roy Duineveld <[email protected]>

…ature/sitemap

royduin

When generated they aren't ignored by the .gitignore by default I think?

src/Jobs/GenerateTermSitemapJob.php

src/Jobs/GenerateStoreSitemapJob.php

kevinmeijer97 · 2024-10-18T09:12:27Z

When generated they aren't ignored by the .gitignore by default I think?

Correct, i added a line in the readme for this now!

BobWez98 · 2024-10-21T08:29:18Z

src/RapidezStatamicServiceProvider.php

@@ -2,7 +2,6 @@



De we maybe need to schedule the jobs? So we don't have to manually run this every time a entry get's created.

indykoning · 2024-10-22T07:59:24Z

src/Jobs/GenerateTermSitemapJob.php

+    {
+        $sitemap = $this->sitemapGenerator->createSitemap($this->generateTermSitemap());
+
+        file_put_contents(public_path('sitemap_statamic_taxonomy_' . $this->site->handle() . '_' . $this->taxonomy->handle() . '.xml'), $sitemap);


It's safer to use the Laravel Storage facade for this

royduin · 2024-10-23T08:56:59Z

src/Jobs/GenerateCollectionSitemapJob.php

@@ -28,7 +29,7 @@ public function __construct(
    public function handle(): void
    {
        $sitemap = $this->sitemapGenerator->createSitemap($this->generateCollectionSitemap());
-        file_put_contents(public_path('sitemap_statamic_collection_' . $this->site->handle() . '_' . $this->collection->handle() . '.xml'), $sitemap);
+        Storage::disk('public')->put('sitemap_statamic_collection_' . $this->site->handle() . '_' . $this->collection->handle() . '.xml', $sitemap);


Is the public path always the same as the public disk?

src/Jobs/GenerateCollectionSitemapJob.php

…emap

composer.json

royduin · 2024-11-13T16:07:47Z

src/RapidezStatamicServiceProvider.php

@@ -213,6 +218,41 @@ public function bootUtilities() : static
        return $this;
    }

+    public function bootSitemaps(): static
+    {
+        Schedule::command('rapidez:statamic:generate:sitemap')->twiceDaily(0, 12);


Not sure if we want to force this from the package, maybe put it somewhere in the readme? Or provide a command from rapidez/sitemap where this package hooks into. So you'll just get 1 command which you can schedule yourself which generates all sitemaps.

Changed this around so it hooks into rapidez/sitemap#2.
See: #78 (comment)

README.md

config/rapidez/statamic.php

src/Jobs/GenerateCollectionSitemapJob.php

BobWez98 · 2024-11-14T07:23:03Z

src/Jobs/GenerateCollectionSitemapJob.php

+    }
+
+
+    protected function generateCollectionSitemap() : string


Why not place this in the action?

I'd rather keep the logic for getting the collection entries in the job, same goes for getting the terms in the term job. The action itself is just for building the sitemap based on the given urls.

src/Jobs/GenerateTermSitemapJob.php

Co-authored-by: Bob Wezelman <[email protected]>

…emap

…ature/sitemap

kevinmeijer97 · 2024-11-14T09:36:46Z

This PR is now depending on rapidez/sitemap#2 for it to generate the sitemaps. Although it's still possible to run the command manually, this PR would essentially schedule the sitemap generation to twice per day.

composer.json

src/Commands/GenerateSitemap.php

royduin · 2024-11-21T10:20:13Z

composer.json

        "rapidez/blade-directives": "^0.6",
        "rapidez/core": "^2.13",
-        "justbetter/statamic-glide-directive": "^2.1",
+        "rapidez/sitemap": "^1.0",


This should be raised when rapidez/sitemap#2 is merged and released.

royduin · 2024-11-21T10:23:48Z

src/Actions/GenerateSitemapAction.php

I think it's better that rapidez/sitemap provides this so rapidez/statamic can use it. Any other packages which needs to register a sitemap could also benefit from it.

royduin · 2024-11-21T10:34:03Z

src/Commands/GenerateSitemap.php

Maybe remove it and provide an option from rapidez/sitemap:

rapidez:sitemap:generate = all

rapidez:sitemap:generate statamic

rapidez:sitemap:generate anything-else

And register new sitemaps with Eventy with a key so that can be used here.

royduin · 2024-11-21T10:34:56Z

src/Jobs/GenerateStoreSitemapJob.php

+        }
+    }
+
+    protected function addSitemap($url = null) : string


Also move this to rapidez/sitemap and use that here.

Kevin Meijer added 2 commits October 4, 2024 12:14

Added sitemap command

eabcf58

Updated readme & removed old sitemap

57d2692

kevinmeijer97 requested review from royduin and BobWez98 October 4, 2024 11:21

BobWez98 requested changes Oct 4, 2024

View reviewed changes

royduin requested changes Oct 4, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

src/Commands/GenerateSitemap.php Outdated Show resolved Hide resolved

src/Commands/GenerateSitemap.php Outdated Show resolved Hide resolved

kevinmeijer97 and others added 6 commits October 8, 2024 11:30

Update README.md

9c58982

Co-authored-by: Roy Duineveld <[email protected]>

Updated README

79e1ac1

Merge branch 'feature/sitemap' of github.com:rapidez/statamic into fe…

718471c

…ature/sitemap

Moved sitemap generation to jobs

53a459e

Moved all sitemap generation to jobs

3fc834f

Check for uri on term

563d42c

kevinmeijer97 requested review from royduin and BobWez98 October 17, 2024 14:09

royduin requested changes Oct 18, 2024

View reviewed changes

src/Jobs/GenerateTermSitemapJob.php Outdated Show resolved Hide resolved

src/Jobs/GenerateStoreSitemapJob.php Outdated Show resolved Hide resolved

Split duplicate functions to action & updated readme

212e9a4

kevinmeijer97 requested a review from royduin October 18, 2024 09:14

BobWez98 reviewed Oct 21, 2024

View reviewed changes

indykoning reviewed Oct 22, 2024

View reviewed changes

Use Storage facade

dee9d0d

royduin reviewed Oct 23, 2024

View reviewed changes

src/Jobs/GenerateCollectionSitemapJob.php Outdated Show resolved Hide resolved

Kevin Meijer added 2 commits November 13, 2024 12:06

Merge branch 'master' of github.com:rapidez/statamic into feature/sit…

444e29d

…emap

Refactored sitemaps to work with rapidez/sitemap

442abc5

royduin reviewed Nov 13, 2024

View reviewed changes

composer.json Outdated Show resolved Hide resolved

Updated Rapidez Sitemap

de74978

royduin reviewed Nov 13, 2024

View reviewed changes

BobWez98 requested changes Nov 14, 2024

View reviewed changes

kevinmeijer97 and others added 5 commits November 14, 2024 10:13

Added env variable

843159a

Co-authored-by: Bob Wezelman <[email protected]>

Added generate action + changed readme

9f94bde

Merge branch 'master' of github.com:rapidez/statamic into feature/sit…

a8ad603

…emap

Inject action

f8cf8fc

Merge branch 'feature/sitemap' of github.com:rapidez/statamic into fe…

8ac859d

…ature/sitemap

Fixed syntax error

b1b4e0f

kevinmeijer97 requested review from BobWez98, royduin and indykoning November 15, 2024 08:59

BobWez98 requested changes Nov 15, 2024

View reviewed changes

composer.json Outdated Show resolved Hide resolved

composer.json Outdated Show resolved Hide resolved

src/Commands/GenerateSitemap.php Outdated Show resolved Hide resolved

Set version Rapidez Sitemap & removed enter

d66bce4

kevinmeijer97 requested a review from BobWez98 November 19, 2024 14:26

royduin requested changes Nov 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added sitemap for collections & taxonomies #78

Added sitemap for collections & taxonomies #78

kevinmeijer97 commented Oct 4, 2024

BobWez98 Oct 4, 2024

kevinmeijer97 Oct 8, 2024

BobWez98 Oct 8, 2024

kevinmeijer97 Oct 8, 2024

royduin Oct 8, 2024

kevinmeijer97 Oct 17, 2024

kevinmeijer97 Oct 17, 2024

BobWez98 Oct 4, 2024

kevinmeijer97 Oct 8, 2024

royduin left a comment

kevinmeijer97 commented Oct 8, 2024

royduin left a comment

kevinmeijer97 commented Oct 18, 2024

BobWez98 Oct 21, 2024 •

edited

Loading

indykoning Oct 22, 2024

royduin Oct 23, 2024

royduin Nov 13, 2024 •

edited

Loading

kevinmeijer97 Nov 14, 2024

BobWez98 Nov 14, 2024

kevinmeijer97 Nov 14, 2024

kevinmeijer97 commented Nov 14, 2024

royduin Nov 21, 2024

royduin Nov 21, 2024

royduin Nov 21, 2024

royduin Nov 21, 2024

Added sitemap for collections & taxonomies #78

Are you sure you want to change the base?

Added sitemap for collections & taxonomies #78

Conversation

kevinmeijer97 commented Oct 4, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

royduin left a comment

Choose a reason for hiding this comment

kevinmeijer97 commented Oct 8, 2024

royduin left a comment

Choose a reason for hiding this comment

kevinmeijer97 commented Oct 18, 2024

BobWez98 Oct 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

royduin Nov 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevinmeijer97 commented Nov 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BobWez98 Oct 21, 2024 •

edited

Loading

royduin Nov 13, 2024 •

edited

Loading