Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

Manage component README #80

Merged
merged 2 commits into from
Jun 10, 2022
Merged

Manage component README #80

merged 2 commits into from
Jun 10, 2022

Conversation

simu
Copy link
Member

@simu simu commented Jun 9, 2022

This PR adds a template for the component README.md.

Addititionally, the PR also changes how the contents of docs/antora.yml are managed: we no longer need the parameters name and title for docs/antora.yml in the components' .sync.yml, instead we construct the component name ("slug" in the cookiecutter component template) from the GitHub repo name, and use :global.componentName as the component title ("name" in the cookiecutter template).

Commodore PR: projectsyn/commodore#529

Checklist

  • The component template has a PR open that syncs the changes with this one.
  • Categorize the PR by setting a good title and adding one of the labels:
    bug, enhancement, documentation, change, breaking, dependency
    as they show up in the changelog
  • Link this PR to related issues.

@simu simu added the enhancement New feature or request label Jun 9, 2022
@simu simu force-pushed the feat/manage-readme branch from ae08065 to 415e0ff Compare June 9, 2022 14:28
@simu simu marked this pull request as ready for review June 9, 2022 14:31
@simu simu force-pushed the feat/manage-readme branch from 415e0ff to 93890aa Compare June 9, 2022 14:32
@simu simu requested a review from bastjan June 9, 2022 14:32
simu added a commit to projectsyn/documentation that referenced this pull request Jun 9, 2022
simu added a commit to projectsyn/documentation that referenced this pull request Jun 9, 2022
simu added a commit to projectsyn/documentation that referenced this pull request Jun 9, 2022
simu added a commit to projectsyn/documentation that referenced this pull request Jun 9, 2022
@simu simu merged commit 5cd320e into master Jun 10, 2022
@simu simu deleted the feat/manage-readme branch June 10, 2022 08:34
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants