advanced-go-programming-book · GitBook
source link: https://www.gitbook.com/book/chai2010/advanced-go-programming-book/details?
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Build a culture of transparency & documentation, organically.
A workflow for everyone, intuitive and automated.
Create
Never start from scratch
It’s easy to get up and running in GitBook—just sync with an existing Git branch or import from Confluence, Notion, GitHub, Dropbox Paper, and Google Docs. A powerful, real-time block editor lets you rearrange everything as you go with support for code blocks, images, tables and more.
- Markdown or WYSIWYG
- Ready-to-use templates
- Multiple page imports
- Nest and group pages
Collaborate
Engage across teams
Whether you’re pre-planning a release or collaborating on public docs, GitBook offers multiple ways for both technical and non-technical stakeholders to contribute. Get approvers to sign off, then open up for feedback from peers. Everyone works async—start discussions, tag teammates and thread comments. Consensus, reached.
- Slack notification
- Approvals process
- Guest writer access
- Activity feed
Review
Create a source of truth
Turn ideas into proposals, then allow collaborators to contribute through change requests (or direct editing). With Git Sync, you can maintain planning and product docs that are as updated as your codebase. Commit (and edit) without fear—your original content is protected and there’s a record of every change. It’s the Git you know, minus the complexity.
- Git-like version control
- Protect your
mainbranch - Bi-directional Git sync
- Conflict alerts
Secure
Your content, your way.
Keep an internal archive detailing every product release, from first PR to final merge. And if you’re looking to empower partners, power users and external developers, visitor authentication allows you to share content, securely. The bottom line? You maintain complete control over who views your content (and when).
- Tiered permissions
- Manage access anytime
- SSO/SAML
- Visitor authentication
Publish
User–ready public docs
Ready to ship? Launch public docs that match your product and brand, from custom colors to subdomains. You worry about the content, GitBook takes care of everything else. Responsive, mobile-friendly and SEO-optimized, automatically.
- Set custom domains
- Custom colors and logos
- Automatically indexable
- Internationalization
Maintain
Always up to date
Docs are only as good as they’re updated. Use bi-directional Git Sync to keep public docs in sync with your codebase. A user-facing feedback system and backend analytics also mean you’re getting a constant temperature check on what pages are working—and where your gaps are.
- Page ratings
- GitHub/GitLab integrations
- Insights & analytics
- Content feedback
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK