Move to community development model¶
In November 2018, Elegant’s wider community was called into a discussion about the future of their beloved theme. The call-out and initial organisation was made by Matija Šuklje, with many responding – and with Talha as the first to support the proposal of changing the development model from a single-developer to a community-led project. The same month several pillars for a community-led project were established.
Talha Mansoor moved Elegant from a simple personal repository to a separate organisation (more on that below), which currently consist of (in alphabetical order):
- Pablo Iranzo Gómez – “iranzo” – owner
- Talha Mansoor – “talha131” – owner
- Ashwin Vishnu Mohanan – “ashwinvis” – member
- Matija Šuklje – “silverhook” – owner
- Andrew Wegner – “AWegnerGitHub” – member
- Calf Zhou – “calfzhou” – owner
This way, the bus factor of the project has greatly improved and we can look into a bright future of this wonderful theme!
New governance model¶
Since the code base is suddenly tended by several people, some basic rules of governance had to be set up in order to avoid people stepping on each-others toes.
As a start, the above-listed project members are not set in stone and discussion just started on guidelines for adding new members and admins to the organization.
We clarified the outbound and inbound licensing situation. Elegant is released (= outbound license) under the MIT license and its documentation under the CC-BY-4.0 license. All code contributions are made directly under the “Inbound=Outbound licensing model”, as the license everyone contributes their code under (i.e. inbound license) is exactly the same as the license that the code is then being released under to the general public.
The contribution guidelines have been updated as well and should be easier to follow now.
We have also started discussing how to vote on new features and other important decisions, which should be implemented soon.
If you are interested in helping with the governance processes, feel free to check out the issues relevant to project management.
New website & documentation¶
Any good project needs good documentation and deserves a good homepage.
We decided to eat our own dogfood by having our documentation run on an Elegant-themed Pelican instance. This would double as a proper demo website as well as a common testing ground for the team.
… and so https://pelican-elegant.github.io/ was born!
As we write this blog post, the discussion on how to tackle future releases is still on-going, so it is a great time for you, dear (potential) Elegant user, to join in and influence our plans together.
Right now, the discussion seems to go in the line of:
- 2.0 – All those fixes and features that do not require creating Pelican plugins or changes in Pelican code. This release will have updated and additional documentation too. (what we just released)
- 2.1 – Make theme compatible with Pelican 4.* Open PR against branch “dev-2.1”.
- 3.0 – Next generation Elegant – the biggest goal is to remove dependency on Bootstrap, to make it easier to maintain. 3.0.0 should have feature parity with 2.0.0.
Invitation to participate¶
If you have not tried Elegant yet do give it a try and even if you have tried it before, please do not hesitate to give Elegant a new try – a lot has improved!
You can use the new release already, but if you just want to browse a bit – our brand new documentation and homepage at https://pelican-elegant.github.io is a great demo for the theme.
If you like the theme and would like to contribute to Elegant, you are most welcome to do so. Even though Pelican is written in Python, no coding skills are needed to help out with Elegant, as themes consist mostly of Jinja templates, CSS and HTML. It is honestly very easiy to get into. If you want to help out, but have no idea where to start, we keep a list of low-priority features that are just waiting for you to pick up. Please consult the
CONTRIBUTING.md file for the technical details.
Another way to contribute is to help with the website/documentation. We are keeping a list of good first issues for newbies to get involved – these are easy to tackle, but in no way less helpful. With the migration from Talha’s personal website, while functional, there is still quite some work to make Elegant’s new home neat and tidy. So there are a lot of small tasks where you can help out here and make an impact!
And, of course, reporting bugs and filing feature requests to further improve Elegant (and its documentation), is also very much welcome.