search

SpongePowered / SpongeDocs

Documentation for Sponge and its Implementations
Creative Commons Attribution Share Alike 4.0 International
110 stars 116 forks source link

Larger scale examples #690

Open parlough opened 6 years ago

parlough commented 6 years ago

At the moment, we have small samples throughout the documentation, and we have some commonly outdated larger samples in the Cookbook repository. I am pondering adding a new section under the Creating a plugin category with pages about larger scale samples, with some information on the docs, maybe some code snippets, and links to the full projects.

If this comes to fruition, I hope it replaces Cookbook and acts as a great place for new developers to see updated, large scale examples, with more in-depth documentation on their individual purposes and their methods of doing so.

I am considering either creating each one as its own repository in a new organization, but I would also be open to creating a new mono-repo in the SpongePowered organization. Either way I need a name similar to Cookbook but more Sponge specific that somehow relates to plugin samples. I have a feeling Inscrutable can come up with something good here.

To help guarantee these plugins are kept up to date, it is a possibility we could include them as a Git submodule in Spongecommon as the test suite.

Note: I am not sure on the timeline for this, but due to its larger scale(and the fact SpongeAPI will change a lot soon) it is fairly low priority compared to other issues and Sponge implementation work at the moment.

gabizou commented 6 years ago

Ideally, the larger scale plugins would be provided from SpongeCommon/testplugins since those are required to compile and well... work. Since they're used for testing and proving something is working, I think it should be responsible for wooing some more advanced plugin examples.

parlough commented 6 years ago

@gabizou I would like to keep the plugins in their own repository, as they are more specific to the API(and can be used on other implementations), and I want to be able to work on them without opening up all of Sponge. They are easier to view for others that way as well(which is the intention of these samples). I would be happy to include them as a Git submodule though inside of SpongeCommon. How does that sound?

I planned to flesh out testplugins more anyway, so I guess this kills two birds with one stone.

gabizou commented 6 years ago

I'd be ok with that. Let me know what you want the repository named (or we could just destroy the cookbook plugin repo and rewrite it with the test plugins). One issue could be for the plugins themselves having the dependency on spongeapi from the parent gradle files wouldn't quite work out without importing spongecommon.

Inscrutable commented 6 years ago

Substituting the existing CookBook would be acceptable, as it's often out-of-date, but might lead to confusion. A new repo would be better. Some name suggestions: The Sideboard, Sink, SqueegeeFarm, Blotter, SpongeToolBox, AbsorBook, SplatKit, SpongeGallery, the Galley, HomeSponge, Saturator, SpongeKaboodle, Infusion Pool, Reservoir, Lake Spongie, The Sea of Sponge, Soakbox, Spongy Skeletons, Porous Templates, The Wringer, Spongie's SandBox, Sliced Sponge ....

parlough commented 6 years ago

I was waiting for your name suggestions ❤️

I'm not sure which I like best just yet...but I'll sleep on it.

In relation to the Gradle requirements for SpongeCommon, we can probably work some Gradle magic in overriding their SpongeAPI dependency to be the API submodule when loaded in. Might need some help on that once I get to that point, but we can figure something out.

Grauldon commented 6 years ago

How about these for name suggestions:

SpongeSamples SpongeXamples SpongeModels SpongeNstance (as in Sponge instance) SpongeUstrate (as in Sponge illustration) SpongeOnstration (as in demonstration)