Skip to content

Standardize title section #220

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

Merged
merged 2 commits into from
Sep 24, 2020
Merged

Standardize title section #220

merged 2 commits into from
Sep 24, 2020

Conversation

spier
Copy link
Member

@spier spier commented Sep 22, 2020

While working on the automation for the book creation, I needed to parse out the pattern titles from the markdown files.
I realized that some titles are using a different formatting, which makes the parsing harder and the book also looks a tiny bit inconsistent then.

In this PR I change this:

  • remove italics from titles
  • move aliases for pattern titles to a separate Alias section. This gives the pattern one clear main name. the aliases could later be used as separate links to the same pattern if we like to do that.

@lenucksi we don't have the "Alias" section header defined in the Pattern template. However I assumed that extra headers are fine to add, as long as they don't contract the other headers.

Should I add a definition of the "Alias" section to the Pattern template file as well?

@lenucksi
Copy link
Member

lenucksi commented Sep 22, 2020

While working on the automation for the book creation, I needed to parse out the pattern titles from the markdown files.
I realized that some titles are using a different formatting, which makes the parsing harder and the book also looks a tiny bit inconsistent then.

In this PR I change this:

  • remove italics from titles

  • move aliases for pattern titles to a separate section (this gives the pattern one clear main name. the aliases could later be used as separate links to the same pattern if we like to do that)

Thanks, looks good to me.

@lenucksi we don't have the "Alias" section header defined in the Pattern template. However I assumed that extra headers are fine to add, as long as they don't contract the other headers.

Should I add a definition of the "Alias" section to the Pattern template file as well?

If we assume this to be used consistently it should go into what currently is used for sort-of "documentary" purposes, i.e. the template.
Also having this in a separate section will allow us to use this to index or other parser uses later on.

@lenucksi lenucksi added the (Self-) Hosting Everything around artifact rendering and presentation. label Sep 22, 2020
Copy link
Member

@lenucksi lenucksi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should document the use of alias in the pattern template as illustrated above. Good otherwise.

@spier
Copy link
Member Author

spier commented Sep 22, 2020

Done!

@spier spier changed the title remove italics from titles. move aliases for pattern titles to a separate section. Standardize title section Sep 23, 2020
@spier spier requested a review from lenucksi September 24, 2020 08:11
Copy link
Member

@lenucksi lenucksi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lenucksi lenucksi merged commit b3372ac into InnerSourceCommons:master Sep 24, 2020
@spier spier deleted the fix-title-formatting branch September 24, 2020 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
(Self-) Hosting Everything around artifact rendering and presentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants