InnerSourcePatterns
InnerSourcePatterns copied to clipboard
Generate landing pages for pattern adopters
Implements #623
1st implementation approachs:
-
take a list of predefinded organization names (e.g. from a file
adopters.txt
) -
loop through all pattern files
-
extrac the "Known Instances" section
-
check if it contains the name of the organization, and if yes, story it in a list dict[org] => [list of patterns]
-
then generate a file
adopters/<org_name>.md
-
write a list of patterns to that file
-
commit these changes
-
have the
book.yaml
GHA run after this, so that it can pick up theseadopters/*.md
files, and add them totoc.md
Scenario: create a page with subpages in gitbook like this
* Parent Page
* [S1](sub-page1.md)
* [S2](sub-page1.md)
If you don't provide a file for "Parent Page", then gitbook will automatically create a page, where it lists all sub pages. That's kind of nice.
I would like to add some explanation to that parent page though, i.e. to describe what the content on the sub pages is. However I don't know to do that while still keeping the automatic "list all subpages" feature.
As part of this I am also experimenting with more visual configuration options of gitbook (see README.md
).
Not sure yet if this will be part of the finale PR.
Would you like updates to the adopters pages for specific companies at this point, @spier ?
Would you like updates to the adopters pages for specific companies at this point, @spier ?
hi @gruetter. I am still experimenting with this, so I would say let's finish a basic v1 of this that we can launch, and then add content/features.
This raises an interesting point though: Do you mean that you want to be able to customise an individual adopter page? e.g. add some custom content to the Bosch page? If we allow that, this would come with some technical challenges (which I am sure we can fix). Also raises questions about how to review such content, not letting it become purely promotional, etc.
Before getting too worried about possible challenges, can you elaborate a bit about the content that you would like to add? Can you share some examples maybe?