Skip to content

Commit

Permalink
developing salt docs is done.
Browse files Browse the repository at this point in the history
  • Loading branch information
@watermelonbig
watermelonbig committed Mar 15, 2020
1 parent 4fc2e69 commit 998a31a
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 76 deletions.
62 changes: 24 additions & 38 deletions 24.Developing-Salt.md
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Developing Salt

+ Overview
+ Salt Client
+ [Overview - 概览](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md)
+ [Salt Client](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md#Salt-Client)
- Overview
+ Salt Master
+ [Salt Master](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md#Salt-Master)
- Overview
- Moving Pieces
- Publisher
- EventPublisher
- MWorker
- ReqServer
- Job Flow
+ Salt Minion
+ [Salt Minion](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md#Salt-Minion)
- Overview
- Event System
- Minion Job Flow
+ A Note on ClearFuncs vs. AESFuncs
+ Contributing
+ [A Note on ClearFuncs vs. AESFuncs](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md#A-Note-on-ClearFuncs-vs.-AESFuncs)
+ [Contributing](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-2.Contributing.md)
- Salt Coding Style
- Sending a GitHub pull request
- Salt's Branch Topology
Expand All @@ -26,30 +26,27 @@
- Mentionbot
- GPG Verification
- Bootstrap Script Changes
+ Deprecating Code
+ Installing Salt for development
+ [Deprecating Code](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-3.Deprecating-Code.md)
+ [Installing Salt for development](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-4.Installing-Salt-for-development.md)
- Running a self-contained development version
- Installing Salt from the Python Package Index
- Editing and previewing the documentation
- Running unit and integration tests
- Issue and Pull Request Labeling System
+ GitHub Labels and Milestones
+ [GitHub Labels and Milestones](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-5.GitHub-Labels-and-Milestones.md)
- Milestones
- Labels
+ Logging Internals
+ Package Providers
+ [Package Providers](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-6.Package-Providers.md)
- Package Functions
- Package Repo Functions
- Low-Package Functions
+ Pull Requests
+ Reporting Bugs
+ Salt Topology
+ [Pull Requests](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-7.Pull-Requests.md)
+ [Reporting Bugs](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-8.Reporting-Bugs.md)
+ [Salt Topology](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-9.Salt-Topology.md)
- Servers
- PUB/SUB
- Return
+ Translating Documentation
- Building A Localized Version of the Documentation
+ Developing Salt Tutorial
+ [Developing Salt Tutorial](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-10.Developing-Salt-Tutorial.md)
- Fork
- Clone
- Fetch
Expand All @@ -59,22 +56,22 @@
- Push
- Merge
- Resources
+ Modular Systems
+ [Modular Systems](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-11.Modular-Systems.md)
- Developing New Modules
- Configuration Options
- Loading Modules
- Module Types
+ Salt Extend
+ [Salt Extend](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-12.Salt-Extend.md)
- Command line usage
- Choosing a template
- Adding templates
- API
+ Salt's Test Suite
+ [Salt's Test Suite](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-13.Salt-Test-Suite.md)
- Test Directory Structure
- Running The Tests
- Automated Test Runs
- Writing Tests
+ Integration Tests
+ [Integration Tests](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-14.Integration-Tests.md)
- Preparing to Write Integration Tests
- Best Practices
- Integration Classes
Expand All @@ -83,7 +80,7 @@
- Destructive vs Non-Destructive Tests
- Cloud Provider Tests
- Adding New Directories
+ Writing Unit Tests
+ [Writing Unit Tests](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-15.Writing-Unit-Tests.md)
- Introduction
- Preparing to Write a Unit Test
- Best Practices
Expand All @@ -93,39 +90,28 @@
- A Simple Example
- A More Complete Example
- A Complex Example
+ raet
- Protocol
- Header
- Packet
- Header Fields
- Session Bootstrap
- Session
- Service Types or Modular Services
+ SaltStack Git Policy
+ [SaltStack Git Policy](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-16.SaltStack-Git-Policy.md)
- New Code Entry
- Release Branching
+ Salt Conventions
+ [Salt Conventions](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-17.Salt-Conventions.md)
- Writing Salt Documentation
- Salt Formulas
- SaltStack Packaging Guide
- Salt Release Process
- Salt Coding Style
+ Salt code and internals
+ [Salt code and internals](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-18.Salt-code-and-internals.md)
- Contents
+ Salt Community Projects
+ [Salt Community Projects](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-19.Salt-Community-Projects.md)
- Hubblestack
- alkali
- buoyant
- Salt Sandbox
- Salt Vagrant Demo
+ Salt's Test Suite: An Introduction
+ [Salt's Test Suite: An Introduction](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter05/05-8-20.Salt-Test-Suits-an-introduction.md)
- Getting Set Up For Tests
- Test Directory Structure
- Running the Test Suite
- Writing Tests for Salt
- Checking for Log Messages
- Automated Test Runs
- Additional Testing Documentation


https://docs.saltstack.com/en/latest/topics/development/architecture.html
15 changes: 15 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,21 @@ https://docs.saltstack.com/en/latest/contents.html
- [Multi Master Tutorial - Multimaster架构的配置教程](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter20/20-2.MULTI-MASTER-TUTORIAL-Multimaster架构的配置教程.md)
- [Multi-Master-PKI Tutorial With Failover - 给合使用PKI和failover的Multimaster架构](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter20/20-3.Multi-Master-PKI-Tutorial-With-Failover-给合使用PKI和failover的Multimaster架构.md)
+ [Windows](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/23.Windows.md)
+ [Developing Salt - Salt开发指南](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/24.Developing-Salt.md)
- [Overview - 概览](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md)
- [Salt Client](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md#Salt-Client)
- [Salt Master](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md#Salt-Master)
- [Salt Minion](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md#Salt-Minion)
- [A Note on ClearFuncs vs. AESFuncs](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-1.Overview.md#A-Note-on-ClearFuncs-vs.-AESFuncs)
- [Contributing](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-2.Contributing.md)
- [Deprecating Code](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-3.Deprecating-Code.md)
- [Installing Salt for development](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-4.Installing-Salt-for-development.md)
- [GitHub Labels and Milestones](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-5.GitHub-Labels-and-Milestones.md)
- [Package Providers](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-6.Package-Providers.md)
- [Pull Requests](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-7.Pull-Requests.md)
- [Reporting Bugs](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-8.Reporting-Bugs.md)
- [Salt Topology](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-9.Salt-Topology.md)
- [Developing Salt Tutorial](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/chapter24/24-10.Developing-Salt-Tutorial.md)
+ [Master Tops](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/26.Master-Tops.md)
+ [Minion Data Cache - Minion数据缓存](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/28.Minion-Data-Cache.md)
+ [Slots](https://github.com/watermelonbig/SaltStack-Chinese-ManualBook/blob/master/29.Slots.md)
Expand Down
Loading

0 comments on commit 998a31a

Please sign in to comment.