-
Notifications
You must be signed in to change notification settings - Fork 7
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
Add a Contributing guide #15
base: master
Are you sure you want to change the base?
Conversation
The intent of this PR is to move the changes in laminas/laminas-form#65 to a more globally accessible location, one that can be referenced in all of the sub-repositories of the Laminas and Mezzio organisations. Signed-off-by: Matthew Setter <[email protected]>
d3b245a
to
5c22f25
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this guide. Following it is straight forward. I ran into the two mentioned issues. Apart from that really good. Thanks!
This change: - Updates the reference to the Yaml snippet so that it's more generic, and applicable to any project, and doesn't use a fixed line range reference. - Removes the ampersand from the serve command reference, so that no errors are thrown for Windows users. - Updates the setup instructions to reference the PyMdown extension Signed-off-by: Matthew Setter <[email protected]>
187fd32
to
02c22b2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Beside my small notes, a question is still open: should we add the way via update script?
python /path/to/documentation-theme/update_mkdocs_yml.py 'https://docs.laminas.dev/laminas-form' docs/book
Responded to two points of feedback.
I don't quite follow what you're asking. Chat with you later today, on Slack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only one more change is needed.
To do so, you first need to do three things; these are: | ||
|
||
1. Have MkDocs installed. | ||
2. Have the Laminas documentation theme available to the laminas-form directory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2. Have the Laminas documentation theme available to the laminas-form directory. | |
2. Have the Laminas documentation theme available to the current repository directory. |
Description
The intent of this PR is to move the changes in laminas/laminas-form#65 to a more globally accessible location, one that can be referenced in all of the sub-repositories of the Laminas and Mezzio organisations.