This repository has been archived by the owner on Apr 12, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 34
Documentation Progress
Joseph Cayouette edited this page Feb 14, 2017
·
1 revision
- rhn.conf parameters (MB Best Practices contains most of these options)
- API Use (Create some solid examples based of scripts from field)
- Salt (Ongoing) The GS guide needs work after our internal training I will review with Karl and Frank SLES vs. Manager
- Error feedback & logging (Not much on this)
- Autoinstallation (exists in 2.1 needs to be updated for Salt and added to 3.1
- Command Line Tools (Not much on this: Cloning Tools, lifecycle etc.) ( We have Jeffs lifecycle guide which is a solid start)
- Organization and Group Management (Setup using salt and traditional methods)
- Patching Systems (Clarify methods for patching an organization, group or system) salt and traditional
New work items will be added here. The status of these items will be marked with:
- IN_PROG
- DONE
- NEXT
- DEVEL
- Migration from svn to Github new repo: DONE
- New TOC for books created with customer, engineering & sales feedback: DONE
- Channel Management: DONE
- SUSE Manager and System z: DONE
- Docreview Development Begins (Currently Internal for uniting QA, DEV, ENG, and Documentation: Pare work with Kwalter)
- Writethedocs Conference Prague: DONE
- Quickstart Guide Installation: DONE
- Quickstart Guide Setup: DONE
- Quickstart Using Salt (Technical Preview Draft 1): DONE
- DocBook version 4.5 to 5.1 migration: DONE
- DocReview in production: DONE
- Best Practice Draft 1: DONE
- Advanced Topics Book Draft 1: DONE
- Optimizing Apache Tomcat Parameters: DONE
- Book / chapter and section ID's updated to reflect SUSE Manager WebUI KE/MC/Coyote: DONE
- Contact Methods (rhnsd, ssh push, ssh push tunnel, osad, salt): DONE
- Managing Entitlements SCC and SMT: DONE
- Reference Book Update: DONE
- Advanced Patch Lifecycle Management Draft 1: DONE
- Activation Key Use and Guidelines: DONE
- Subscription Matching: DONE
- System Details: Salt State Components Draft 1 (Packages, Custom, Highstate): DONE
- 2.1 - 3 Comparison Chart and Supported Features: Maintained : DONE
- SUSE Manager 3 Proxy: DONE
- Licenses for AT and BP: DONE
- Icinga Guide: DONE
- Adding a VMware ESXi Host to SUSE Manager: DONE
- Using Salt Proxies: DONE
- Expanded Support Draft 1: DONE
- Config Management with Salt Draft 1: DONE
- Salt Minion Scalability Draft 1: Will be revised later with Moio's work: DONE
- Common Administration Tasks: Done
- Database Backup and Restoration Draft 1: DONE
- System Audititing and Security Management: DONE
- Troubleshooting Draft 1: Ongoing : DONE
- Additional Resources (YAML, JINJA, Salt BP): Ongoing: DONE
- Using Custom SSL Certificates: DONE
- Documentation Updates Book Draft 1: DONE
- White Papers Book (Internal for ENG, QA, Testing) May release specific docs to .com: DONE
- Writing Custome Salt Grains Draft 1: (White Papers): DONE
- Creating Custom Execution Modules Draft 1: DONE
- Creating a Machinery Renderer Draft 1: DONE
- Writing a Salt Execution Module for the Raspberry Pi 3 and a SenseHat Module: DONE
- Salt Formulas and Forms Draft 1: DONE
- Live Patching: DONE
- spacecmd Reference: DONE
- Service Pack Migration: DONE
- Salt Getting Started Draft 1 : DONE
- Update 2.1 - 3 Migration: DONE
- Update Refs SP1 - SP2: DONE
- Using a proxy during SLES Setup (Manager installation): IN_PROG
- Connecting minions to trusted master only: NEXT
- Live Patching Cleanup: NEXT
- Documentation Updates Book (Customers can see what has been added recently with links to content Manager/build.suse.de
- Content Management: DEVEL
- Config Drift: DEVEL
- openScap Minions: DEVEL
- GS Update (Salt and Traditional clean up):
- Visualization: DEVEL
- Salt SSH Push: DEVEL
Setup and Build
- Setup rbenv and Ruby
- Install nvm
- Install Antora
- Install Asciidoctor Gems
- Building the Docs
- Optional Tools
How to Publish
Publish to OBS
Publish Enterprise Docs
Publishing to Github Pages
Want to Help?
Get Started with Asciidoc
Quick Syntax Reference
Asciidoctor Writer's Guide
Asciidoctor User's Manual
Resources
YAML Documentation