Add a docs contributing guide to the README

[settermjd]

Q	A
Documentation	yes
Bugfix	no
BC Break	no
New Feature	no
RFC	no
QA	no

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.

[froschdesign]

@weierophinney
This is a very good extension and we need the explanation. (The path with Docker should be added too.)
But I would move this to a separate repository like documentation. There we can add some more content like a documentation writer's guide.
All contents can be displayed under docs.laminas.dev and linked in the readme files.

[weierophinney]

@weierophinney
This is a very good extension and we need the explanation. (The path with Docker should be added too.)
But I would move this to a separate repository like documentation. There we can add some more content like a documentation writer's guide.
All contents can be displayed under docs.laminas.dev and linked in the readme files.

I would argue for:

• Put this information in the documentation repository.
• Add a section in the laminas/.github CONTRIBUTING.md file titled "Contributing Documentation" that summarizes the "we use Markdown and MkDocs" information, and then links to the larger write-up in the documentation repository. (And do this in each of the .github repos of each organization)

[froschdesign]

• Add a section in the laminas/.github CONTRIBUTING.md

Very good, I hadn't thought of that at all. 👍

[settermjd]

Thanks for the feedback, everyone. I'll get it done.

[settermjd]

@weierophinney
This is a very good extension and we need the explanation. (The path with Docker should be added too.)
But I would move this to a separate repository like documentation. There we can add some more content like a documentation writer's guide.
All contents can be displayed under docs.laminas.dev and linked in the readme files.

Did you mean the "documentation-theme" repository? Otherwise, I'm not sure which repository you mean.

[weierophinney]

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.

[settermjd]

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

[froschdesign]

@weierophinney

I can transfer that repo to the Laminas org, if you'd like…

That would be great. Thanks in advance!

[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.

[settermjd]

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.

[settermjd]

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.

[froschdesign]

@settermjd

I moved the contributing documentation to the documentation repository in laminas/documentation#15.

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!