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

Template for new files at GitHub: add info on customization #1648

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

deining
Copy link
Collaborator

@deining deining commented Aug 5, 2023

The template file new-page-template.md specifies the frontmatter and content used for new pages at GitHub (via link Create new child page in the right sidebar). This PR adds documentation on how to override the frontmatter and the content defined in this file via a project specific file in your project.

Copy link
Collaborator

@chalin chalin left a comment

Choose a reason for hiding this comment

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

I think that we should document this feature in the User Guide instead of adding an HTML comment to the template file, since the information is more pertinent to website maintainers than to contributors adding a new page.

My 2 cents. WDYT @emckean @LisaFC @geriom?

@deining deining changed the title Template for new files at GitHub: add docu for customization Template for new files at GitHub: add info on customization Aug 19, 2023
@deining
Copy link
Collaborator Author

deining commented Aug 19, 2023

I think that we should document this feature in the User Guide

This is documented in the user guide already:

* Create child page: Brings the user to a create new file form in their fork of your docs repo.
The new file will be located as a child of the page they clicked the link on.
The form will be pre-populated with a template the user can edit to create their page.
You can change this by adding assets/stubs/new-page-template.md to your own project.

I think that we should document this feature in the User Guide instead of adding an HTML comment to the template file

The HTML comment is an additional reminder, thought as backing of the docu in the userguide. We had support questions in the past regarding the use of this file, so think adding the comment makes sense to me.

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

Successfully merging this pull request may close these issues.

None yet

2 participants