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

Architect shared structure for project meta docs #1

Open
mojavelinux opened this issue Dec 1, 2020 · 2 comments
Open

Architect shared structure for project meta docs #1

mojavelinux opened this issue Dec 1, 2020 · 2 comments

Comments

@mojavelinux
Copy link
Member

Each of the projects hosted at docs.asciidoctor.org will likely need a space for information about the project itself. We should agree on a shared structure to use so that the experience for the reader is consistent.

Meta docs are those that talk about the project itself, as opposed to how to use the project. These docs should be in a top-level section at the bottom of the navigation tree.

First, we need to agree on a title for this section. Here are some suggestions:

  • About Project
  • About
  • Project
  • About {page-component-title}

Please state your preference and why you think it should be chosen.

Second, we need to agree on a name for the module that holds these pages. Here are some suggestions:

  • project
  • about
  • meta

Please state your preference and why you think it should be chosen.

Finally, we need to agree on the scope. If you want, you can just have a single page (e.g., docs/modules/project/index.adoc) that has all the project information. If you want to split it out into more pages, here's a suggested hierarchy:

  • About Project
    • Help Resources
    • Development
    • Copyright & License
    • Sponsorship
    • History

These pages are all optional. They are just meant to be ideas to get you started. If I've missed any, please point out what they are.

If you are using more than one page, the About Project page (e.g., docs/modules/project/index.adoc) should state the motivation and goals of the project, from a development perspective. (This is different than the description on the intro page).

The Development page should only contain high level information about how the project is developed (hosted on GitHub, GitHub issues, etc). It should then link to the CONTRIBUTING.adoc document in the project repository for the details about how to develop and contribute. I don't think that information belongs in the documentation. (If you disagree, please make the case for why it should be).

Please keep in mind that there will be a component in the site that has meta information about the Asciidoctor community as a whole. So the project doesn't need to repeat information such as the GitHub org, the discussion list, or the shared chat channel. But if the project has a specific resource, like a dedicated chat channel, then that should be mentioned in the About page / section for the project.

cc: @Mogztter @abelsromero @robertpanzer @ysb33r

@abelsromero
Copy link
Member

Id' go for "About {page-component-title}".
Unlike the other options it's unambiguous. Plus having the component-title in it adds a warmer personal touch, without it sound bland.

About the pages
I'd argue that Development could be made into it's own module, under each component responsability and adapted of each component technology. That keeps the scope for "About" simple, only exclusevily non-code aspects like history, legal. If we include something about contributing, should be related to a statement that "PR are welcomed", coc and ownership of contributions, PR policies (if not handled in gh templates), not how to develope.

About placement of CONTRIBUTING
Can't decide and I don't have a strong opinion. But following my own previous argument I'd do it the other way arround. Keeping CONTRIBUTING at the root outside of the docs (explaining the policies I mentioned, no coding instructions), and then linking to the development section in the docs that explain how to code.

@slonopotamus
Copy link
Contributor

Development
Copyright & License
Sponsorship

Are you sure this things should go to docs.asciidoctor.org or should just live instead in README of respective repository? Especially "Development" thing. I picture docs.asciidoctor.org to myself as a user-facing documentation on "how to use an existing piece of software" and nothing more.

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

No branches or pull requests

3 participants