Comments (7)
Okay, thanks, I see what you mean.
Your TOC looks like an excellent starting point. I think good enough to at least start trying to research and start writing those things down.
If you have any content for any of those topics, feel free to drop them here or send them my way. I'll also start researching, asking around, and collecting all the things.
from tinkerbell.org.
We have this!
from tinkerbell.org.
I definitely like this! @gianarb
More concretely, are you thinking of making something like the content of https://pkg.go.dev/github.com/tinkerbell/[email protected]/test/framework?tab=doc a part of the documentation?
And to extend the Bird example -
"User Guide" - current Tinkerbell website docs (which are definitely more user-focused currently)
"Coder's Doc" - the Tinkerbell docs generated in the link above (more developer/contributor focused)
We can definitely name the two halves however we want, I just wanted to make sure I was understanding correctly.
from tinkerbell.org.
Hello @DailyAlice !
The documentation you linked is the one used from a developer when learning a framework in the act of embedding code we wrote as part of Tinkerbell in their codebase. It is important and it applies to something like:
- Client Libraries (because those are used by other developers in the act of extending Tinkerbell).
- Testing Framework (the one you linked) that are used when writing tests.
But it is not what I have in my mind for what concerns the Coder's Doc
, I think a better name is Contributors Doc
because the end goal for it should be to help contributors not wasting time on a problem other contributors solved in the act of writing code, troubleshooting and releasing Tinkerbell.
A possible TOC for Contributors Doc
will be:
- How CI works
- How to write e2e tests from Tinkerbell (with a link to the framework you linked probably but also more)
- How to make a release
- Golang style guide for the project (https://thanos.io/contributing/coding-style-guide.md/)
- Troubleshooting Tink GRPC server
- Triaging runbook (@mrmrcoleman is writing it down)
- ...
Topics that users do not care about, but people who want to help will care. I think the way you are picturing Coders
based on what you linked is what I see as a user. The Tinkerbell's user will always interact with an API, it means that client libraries, as well as CLI, are part of the documentation that users care about because those are just different ways to use Tinkerbell.
from tinkerbell.org.
Is there anything I can do to help resolve this in the next week?
from tinkerbell.org.
I don't know how to do it, my expectation is be able to implement a table of contents like:
- Contributors Docs
- Go
- Continuous Integration
- Code review
- Pull request lifecycle
if you can help me to find the right place where I can write those contents I happy to bootstrap them
from tinkerbell.org.
if you can help me to find the right place where I can write those contents I happy to bootstrap them
Started the file on #143 with your requested ToC. Let me know how else I may help.
from tinkerbell.org.
Related Issues (20)
- Tinkerbell.org/docs is still accessible HOT 4
- Local setup docs fix HOT 1
- Update Tinkerbell favicon HOT 3
- Google Search Console site verification HOT 1
- Sitemap Update: Docs HOT 7
- Incomplete sitemap
- Homepage "Get Started" is 404 HOT 1
- Examples hello-world has 404
- Create robots.txt
- Merging Support & Community Slack
- Footer update with CNCF HOT 6
- Add "edit" link to docs pages HOT 7
- hello-world example should direct users on how to fulfill prerequisites HOT 2
- Move Tinkerbell slack from company to CNCF Slack HOT 6
- Main website still lists OSIE, but OSIE has been deprecated in favor of Hook HOT 1
- Add documentation for Rufio
- Add documentation for tinkerbell/charts
- Add documentation around CRDs
- Why are there 2 doc repos? HOT 1
- tinkerbell.org web site down (Netlify issues) HOT 3
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 tinkerbell.org.