Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Generate landing pages for pattern adopters #624

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

Draft
spier wants to merge 31 commits into main
base: main
Choose a base branch
Loading
from generate-adopter-pages

Conversation

@spier
Copy link
Member

@spier spier commented Nov 25, 2023
edited
Loading

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 added 29 commits November 24, 2023 22:46
Copy link
Member Author

spier commented Nov 25, 2023
edited
Loading

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.

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.

Copy link
Contributor

gruetter commented Dec 5, 2023

Would you like updates to the adopters pages for specific companies at this point, @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

Reviewers

@lenucksi lenucksi Awaiting requested review from lenucksi lenucksi will be requested when the pull request is marked ready for review lenucksi is a code owner

@NewMexicoKid NewMexicoKid Awaiting requested review from NewMexicoKid NewMexicoKid will be requested when the pull request is marked ready for review NewMexicoKid is a code owner

@cewilliams cewilliams Awaiting requested review from cewilliams cewilliams will be requested when the pull request is marked ready for review cewilliams is a code owner

@robtuley robtuley Awaiting requested review from robtuley robtuley will be requested when the pull request is marked ready for review robtuley is a code owner

@yuhattor yuhattor Awaiting requested review from yuhattor yuhattor will be requested when the pull request is marked ready for review yuhattor is a code owner

Assignees

No one assigned

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /