mirror of
				https://github.com/vyos/vyos-documentation.git
				synced 2025-10-26 08:41:46 +01:00 
			
		
		
		
	index: establish highlighted blocks without affecting links
Add toctree captions and names to separate blocks (similar to 1.3 index) without affecting existing links
This commit is contained in:
		
							parent
							
								
									ea0a0d7e92
								
							
						
					
					
						commit
						095239eace
					
				
							
								
								
									
										27
									
								
								docs/about.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								docs/about.rst
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,27 @@ | |||||||
|  | .. _about: | ||||||
|  | 
 | ||||||
|  | ##### | ||||||
|  | About | ||||||
|  | ##### | ||||||
|  | 
 | ||||||
|  | VyOS is an open source network operating system based on Debian GNU/Linux. | ||||||
|  | 
 | ||||||
|  | VyOS provides a free routing platform that competes directly with other | ||||||
|  | commercially available solutions from well known network providers. Because | ||||||
|  | VyOS is run on standard amd64, i586 and ARM systems, it can be used | ||||||
|  | as a router and firewall platform for cloud deployments. | ||||||
|  | 
 | ||||||
|  | We use multiple live versions of our manual hosted thankfully by | ||||||
|  | https://readthedocs.org. We will provide one version of the manual for every | ||||||
|  | VyOS major version starting with VyOS 1.2 which will receive Long-term support | ||||||
|  | (LTS). | ||||||
|  | 
 | ||||||
|  | The manual version is selected/specified by its Git branch name. You can | ||||||
|  | switch between versions of the documentation by selecting the appropriate | ||||||
|  | branch on the bottom left corner. | ||||||
|  | 
 | ||||||
|  | VyOS CLI syntax may change between major (and sometimes minor) versions. Please | ||||||
|  | always refer to the documentation matching your current, running installation. | ||||||
|  | If a change in the CLI is required, VyOS will ship a so called migration script | ||||||
|  | which will take care of adjusting the syntax. No action needs to be taken by | ||||||
|  | you. | ||||||
| @ -1,40 +1,26 @@ | |||||||
| .. _index: | .. _index: | ||||||
| 
 | 
 | ||||||
|  | ############### | ||||||
| VyOS User Guide | VyOS User Guide | ||||||
| =============== | ############### | ||||||
| 
 | 
 | ||||||
| VyOS is an open source network operating system based on Debian GNU/Linux. |  | ||||||
| 
 | 
 | ||||||
| VyOS provides a free routing platform that competes directly with other |  | ||||||
| commercially available solutions from well known network providers. Because |  | ||||||
| VyOS is run on standard amd64, i586 and ARM systems, it is able to be used |  | ||||||
| as a router and firewall platform for cloud deployments. |  | ||||||
| 
 |  | ||||||
| ##### |  | ||||||
| About |  | ||||||
| ##### |  | ||||||
| 
 |  | ||||||
| We use multiple live versions of our manual hosted thankfully by |  | ||||||
| https://readthedocs.org. We will provide one version of the manual for every |  | ||||||
| VyOS major version starting with VyOS 1.2 which will receive Long-term support |  | ||||||
| (LTS). |  | ||||||
| 
 |  | ||||||
| The manual version is selected/specified by it's Git branch name. You can |  | ||||||
| switch between versions of the documentation by selecting the appropriate |  | ||||||
| branch on the bottom left corner. |  | ||||||
| 
 |  | ||||||
| ############ |  | ||||||
| Introduction |  | ||||||
| ############ |  | ||||||
| 
 |  | ||||||
| .. _introduction: |  | ||||||
| .. toctree:: | .. toctree:: | ||||||
|  |    :caption: Introduction | ||||||
|  |    :name: intro | ||||||
|    :maxdepth: 2 |    :maxdepth: 2 | ||||||
| 
 | 
 | ||||||
|  |    about | ||||||
|    history |    history | ||||||
|    install |    install | ||||||
|    cli |    cli | ||||||
|    quick-start |    quick-start | ||||||
|  | 
 | ||||||
|  | .. toctree:: | ||||||
|  |    :caption: Configuration | ||||||
|  |    :name: configuration | ||||||
|  |    :maxdepth: 2 | ||||||
|  | 
 | ||||||
|    configuration-overview |    configuration-overview | ||||||
|    interfaces/index |    interfaces/index | ||||||
|    routing/index |    routing/index | ||||||
| @ -51,12 +37,10 @@ Introduction | |||||||
| .. modules | .. modules | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| ######## |  | ||||||
| Appendix |  | ||||||
| ######## |  | ||||||
| 
 | 
 | ||||||
| .. _appendix: |  | ||||||
| .. toctree:: | .. toctree:: | ||||||
|  |    :caption: Appendix | ||||||
|  |    :name: appendix | ||||||
|    :maxdepth: 2 |    :maxdepth: 2 | ||||||
| 
 | 
 | ||||||
|    appendix/releasenotes |    appendix/releasenotes | ||||||
| @ -69,14 +53,11 @@ Appendix | |||||||
|    appendix/migrate-from-vyatta |    appendix/migrate-from-vyatta | ||||||
| 
 | 
 | ||||||
| 
 | 
 | ||||||
| ############ |  | ||||||
| Contributing |  | ||||||
| ############ |  | ||||||
| 
 |  | ||||||
| .. _contributing: |  | ||||||
| .. toctree:: | .. toctree:: | ||||||
|  |    :caption: Contributing | ||||||
|  |    :name: contributing | ||||||
|    :maxdepth: 2 |    :maxdepth: 2 | ||||||
| 
 |     | ||||||
|    contributing/issues_features |    contributing/issues_features | ||||||
|    contributing/development |    contributing/development | ||||||
|    contributing/documentation |    contributing/documentation | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user