feature/issue 1232 static sitemap #1240
Conversation
|
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
added
documentation
www/pages/docs/css-and-images.md
Outdated
| 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
changed the title
thescientist13
force-pushed
the
1232-static-sitemap
branch
from
69aafde to
8b4f430
Compare
thescientist13
merged commit 957a780
into
ProjectEvergreen:release/0.30.0
* #1232 - Adding default static sitemap plugin * 1232 - Adding meta files documentation * update meta files docs and usage examples --------- Co-authored-by: Owen Buckley <[email protected]>
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