On 03/02/22 7:42 pm, Philip Oakley wrote:
On 26/01/2022 18:29, Kaartic Sivaraam wrote:
- Project ideas: There are two mentioned in SoC-2021-Ideas[3]
but both were picked by GSoC students the previous year. So,
we would need new ones this year.
Git Demonstration Repositories
=============================
One idea/concept that I've had that might be suitable for a project
either here or within the Google Season of Docs is to generate
demonstration repositories that match the examples used in the
documentation and parts of the test suite to help users explore and
understand the concepts that are being documented in the man pages.
It's more than a classic coding problem because it impinges on a lot of
subjective and admin areas but should be fairly beneficial for users.
This does sound like a good idea.
The two examples that come to mind are the --show-pulls repo [1], and
the 'history simplification' repo [2].
Using the test suite as the repo generator ensures the Demo Repos are
reproducible/deterministic.
My latest thinking is that the repos would be held in-tree under
/Documentation/RepoBundles and have been exported as bundles by an
explicit test_export_function. Of key importance in the project is to
minimise/eliminate any extra maintainer actions, so once a patch with a
repo export is accepted, the flow through the delivery process to user
installs is essentially the same as the man pages.
We could possibly include this one in the idea list but I suppose we might
need a more concrete idea on what needs to be done as part of this project.
That would help very much with guiding the student during the project
period.
We also need to know if the end result of such a project would be an
acceptable contribution to the project. What it would take for the contribution
to be acceptable? etc.
Just to make it clear, I'm trying to think through on what we need to do to
make this a GSoC idea proposal.
Not sure if that's fleshed out enough, or if it's at the wrong level for
GSoC, or If I'm right as a Mentor, but I'd be happy to co-mentor.
That's nice. Thanks for volunteering.
On a related note, the organization registrations are now open for this year.
The deadline is February 21 - 18:00 UTC. I'm not sure if anyone else is
planning on applying for Git. In case no one else beats me to it, I plan on
applying for Git around February 15 17:00 UTC.
--
Sivaraam
