Comments (5)
This is the moment when we need to understand and/or decide tooling for converting from Markdown files to a webpage.
This should be handled by the GitHub Pages process. We should be able to hand it the source for a "book" as as Markdown file with an organized table of contents of (all the) .md files.
For now, let's start a mock-ToC for what we have and what we want to have. We can put in stubs for content that doesn't exist, too. For some ideas, we can look to the slidedeck from Nuritzi & Jaskirat that has these suggested areas:
About: Mission, Vision, Values, History, Governance model, Code of Conduct
Teams/Groups: how to onboard onto each team, and specific processes that they follow
Handbook: How to use the handbook
Social: How to meet other community members and tools you use to communicate
Another slide notes these topics in their handbook:
About
Community
Contributing
Mentorship
That is also in the CHAOSS repo for testing GitBook.
Maybe a short meeting to or Slack with whiteboard to get some clarity on all this? I wonder who else in the community is interested in documentation tools and knows a bit about what can be done with GitHub Pages?
from community-handbook.
Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale
.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close
.
/lifecycle stale
from community-handbook.
Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten
.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close
.
/lifecycle rotten
from community-handbook.
Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen
.
Mark the issue as fresh with /remove-lifecycle rotten
.
/close
from community-handbook.
@sesheta: Closing this issue.
In response to this:
Rotten issues close after 30d of inactivity.
Reopen the issue with/reopen
.
Mark the issue as fresh with/remove-lifecycle rotten
./close
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
from community-handbook.
Related Issues (20)
- Improve documentation for adding members to the Op1st GitHub org HOT 7
- "How to GitHub" content for general (re)use HOT 6
- Gap analysis for first two rungs of the contributor ladder documentation HOT 6
- Gather a cumulative list of current docs in the Operate First community HOT 5
- how to create calendar entries HOT 7
- publish the complete calendar, e.g. just via a link on the website? HOT 7
- best practice on how to add / create meetings for the invites (afaik, we should use RH meetings, because recording) HOT 7
- Define practices for running a SIG HOT 7
- Create page describing all project repos - purpose, what goes there, etc. HOT 4
- Create landing for our work as a "Getting Started" page HOT 5
- Rebrand to "User and Contributor Handbook" HOT 6
- [How-to] Using the [email protected] mailing list/forum HOT 4
- Rename and link-in the "User and Contributor Handbook" HOT 5
- Make sure new contributors always see a link to get-help/support, which has content for them HOT 4
- Curate and/or create-a-doc: How to make a pull request HOT 4
- Make a list of common Support questions or needs that are documented for a future ToC HOT 5
- Curate and/or create-a-doc: Short cut page for Researchers HOT 5
- Update `/developer` page "Learning Resources" section HOT 5
- Graphic for Open Source developers page showing an operate-first devel pipeline HOT 5
- Operate First quick reference for GitOps HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from community-handbook.