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

feature/issue 1232 static sitemap #1240

Merged

Conversation

jstockdi
Copy link

@jstockdi jstockdi commented Jun 5, 2024

Related Issue

#1232 - Static sitemap copy plugin

Summary of Changes

Created a greenwood default copy plugin to copy a sitemap.xml from the source folder

  1. Created plugin
  2. Updated relevant spec file
  3. Provided example sitemap.xml
  4. Thought about documentation in configuration.md or plugins.md (Happy to help given direction)

@thescientist13
Copy link
Member

Nice, this is looking good!

As for docs, I'm on my phone but was looking at the current website to see if we have robots or favicon documented, but couldn't fine it. 🧐

If robots / favicon are not already documented, I think for now under the Styles and Assets doc might be good, maybe under a new heading section? Maybe call it "Meta Files" or something? (We could call out robots and favicon too if you are feeling ambitious 🙏)

@thescientist13 thescientist13 linked an issue Jun 5, 2024 that may be closed by this pull request
@thescientist13 thescientist13 added documentation Greenwood specific docs CLI feature New feature or request labels Jun 5, 2024
The build includes a few [default copy plugins](https://github.com/ProjectEvergreen/greenwood/tree/master/packages/cli/src/plugins/copy) for common meta files. Typically, they support copying the files from the source directory to the build directory.

* `plugin-copy-favicon.js` - copies favicon.ico. NOTE: Does not support multiple favicons. For multiple support, use the manifest.json or make a custom plugin
Copy link
Member

@thescientist13 thescientist13 Jun 6, 2024

Choose a reason for hiding this comment

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

Nice, I think I will tweak this as it interweaves public API / private implementation / development + testing details all in one, and so I think for the sure of readers, I will probably have it just list out the supported files. You make a good callout that if you need more support, then linking to the copy plugin is a good idea, so will definitely keep that in.

As a side note, manifest.json is more related to Greenwood's own build output, so not really something for users per se, but I do have a PR that is documenting more of that as we speak, as it pertains to adapter plugins anyway, and will likely get its own "Build Output" section when migrated to the new docs website soon.

Copy link
Member

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for this! I am going to queue this up for the next release coming out soon (next 4 - 5 weeks) and is in progress at #1208 . I will get this out in an alpha release before then so will keep you posted. It's a clean enough change so I don't expect any issues rebasing onto that release branch so for now tagging it for alpha.3, which I expect to get by next weekend at the latest.

Looking forward to collaborating on the dynamic version of this next, and can make some time to discuss the approach on our next weekly meeting if you're interested.


edit: also just a reminder you are a collaborator within this org, so you don't have to fork and can commit branches right to upstream, just to help save on the hassle of the forking workflow if we want. 👍

@thescientist13 thescientist13 changed the title #1232 - Adding default static sitemap plugin feature/issue 1232 static sitemap Jun 22, 2024
@thescientist13 thescientist13 changed the base branch from master to release/0.30.0 June 22, 2024 17:29
@thescientist13 thescientist13 merged commit 957a780 into ProjectEvergreen:release/0.30.0 Jun 22, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLI documentation Greenwood specific docs feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sitemap Generation
2 participants