Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate landing pages for pattern adopters #624

Draft
wants to merge 31 commits into
base: main
Choose a base branch
from

Conversation

spier
Copy link
Member

@spier spier commented Nov 25, 2023

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 these adopters/*.md files, and add them to toc.md

@spier
Copy link
Member Author

spier commented Nov 25, 2023

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.

@spier
Copy link
Member Author

spier commented Nov 25, 2023

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.

@gruetter
Copy link
Contributor

gruetter commented Dec 5, 2023

Would you like updates to the adopters pages for specific companies at this point, @spier ?

@spier
Copy link
Member Author

spier commented Dec 8, 2023

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants