-
-
Notifications
You must be signed in to change notification settings - Fork 53
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 docs contributing guide to the README #65
Add a docs contributing guide to the README #65
Conversation
@weierophinney |
I would argue for:
|
Very good, I hadn't thought of that at all. 👍 |
Thanks for the feedback, everyone. I'll get it done. |
Did you mean the "documentation-theme" repository? Otherwise, I'm not sure which repository you mean. |
We had a documentation repo in the ZF org for tracking projects. I never migrated it here, as it didn't have code, mostly projects... @froschdesign I can transfer that repo to the Laminas org, if you'd like; that would give us the projects. I hadn't thought of that, as everything else we were migrating, and then archiving. Let me know if that's what you'd like, or if you'd like me to create a documentation repo. |
I'm all for it being migrated, @weierophinney |
That would be great. Thanks in advance! |
DONE! https://github.com/laminas/documentation I was wrong - no projects, just issues. But they're all there now. |
Thanks for doing that, @weierophinney. |
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]>
I moved the contributing documentation to the documentation repository in laminas/documentation#15. I've added the relevant information to CONTRIBUTING.md in Mezzio's .github in mezzio/.github#6 and Laminas' .github in laminas/.github#8. |
This is part of updating the documentation of all repositories to show how to contribute to the documentation, as recommended in laminas/laminas-form#65 (comment). Signed-off-by: Matthew Setter <[email protected]>
This is part of updating the documentation of all repositories to show how to contribute to the documentation, as recommended in laminas/laminas-form#65 (comment). Signed-off-by: Matthew Setter <[email protected]>
My intention in doing this is to help others get started easier than I did the first time (this time) by including a clear set of instructions that step them through how to build the documentation locally, so that they know that they changes which they contribute will render properly, as they expect them to. A big thanks to @froschdesign for helping me get started. Signed-off-by: Matthew Setter <[email protected]>
Signed-off-by: Matthew Setter <[email protected]>
f5c34b3
to
c679801
Compare
This is the right place for it. The link is already included in the global contributing guidelines for this organisation. The link to the guidelines is added under each comment and issue text field and in the community section of the repository. To avoid duplication, we should use one place for the text and close this pull request. Improvements for text should be added to the documentation repository. We already use the content so nothing is lost. Thanks! |
Description
My intention in doing this is to help others get started easier than I did the first time (this time) by including a clear set of instructions that step them through how to build the documentation locally, so that they know that they changes which they contribute will render properly, as they expect them to.
A big thanks to @froschdesign for helping me get started.