Skip to content

Commit 9ca98c0

Browse files
committed
update docs
1 parent 11bc606 commit 9ca98c0

File tree

136 files changed

+2043
-497
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+2043
-497
lines changed

docs/mkdocs.yml

Lines changed: 102 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,114 +1,119 @@
1-
copyright: Copyright © 2017 - 2021 eNMS Automation
1+
copyright: Copyright © 2017 - 2024 eNMS Automation
22
docs_dir: source
33
repo_url: https://github.com/eNMS-automation
44
edit_uri: ""
55
site_dir: build
66
site_name: eNMS
77
nav:
88
- Getting Started:
9-
- Overview: index.md
10-
- Features: base/features.md
11-
- Installation: base/installation.md
12-
- Release Notes: base/release_notes.md
9+
- Overview: index.md
10+
- Features: base/features.md
11+
- Installation: base/installation.md
12+
- Release Notes: base/release_notes.md
1313
- System:
14-
- Changelog: system/changelog.md
15-
- Dashboard: system/dashboard.md
16-
- Files: system/files.md
17-
- Sessions: system/sessions.md
14+
- Changelog: system/changelog.md
15+
- Dashboard: system/dashboard.md
16+
- Files: system/files.md
17+
- Sessions: system/sessions.md
1818
- Administration:
19-
- Access:
20-
- Overview: administration/overview.md
21-
- Credentials: administration/credentials.md
22-
- Groups: administration/groups.md
23-
- Users: administration/users.md
19+
- Access:
20+
- Overview: administration/overview.md
21+
- Credentials: administration/credentials.md
22+
- Groups: administration/groups.md
23+
- Users: administration/users.md
24+
- Secrets: administration/secrets.md
25+
- Clustering:
2426
- Servers: administration/servers.md
25-
- Tools:
26-
- Admin Panel: administration/admin_panel.md
27-
- Debugging: administration/debug.md
27+
- Workers: administration/workers.md
28+
- Tools:
29+
- Admin Panel: administration/admin_panel.md
30+
- Debugging: administration/debug.md
2831
- Inventory:
29-
- Network Creation: inventory/network_creation.md
30-
- Device Management:
31-
- Devices: inventory/devices.md
32-
- SSH Gateways: inventory/ssh_gateways.md
33-
- WebSSH Connection: inventory/web_connection.md
34-
- Configurations: inventory/configuration_management.md
35-
- Links: inventory/links.md
36-
- Pools: inventory/pools.md
37-
- Networks: inventory/networks.md
32+
- Network Creation: inventory/network_creation.md
33+
- Device Management:
34+
- Devices: inventory/devices.md
35+
- SSH Gateways: inventory/ssh_gateways.md
36+
- WebSSH Connection: inventory/web_connection.md
37+
- Configurations: inventory/configuration_management.md
38+
- Links: inventory/links.md
39+
- Pools: inventory/pools.md
40+
- Data Store: inventory/datastore.md
41+
- Networks: inventory/networks.md
3842
- Visualization:
39-
- Geographical View: visualization/geographical_view.md
40-
- Network Builder: visualization/network_builder.md
43+
- Geographical View: visualization/geographical_view.md
44+
- Network Builder: visualization/network_builder.md
4145
- Automation:
42-
- Services:
43-
- Service Management: automation/services.md
44-
- Service Editor: automation/service_editor.md
45-
- Using Python in the Service Editor: automation/service_python_code.md
46-
- Service Types:
47-
- Service Type Index: automation/service_types.md
48-
- Ansible Playbook Service: automation/servicetypes/ansible_playbook.md
49-
- Data Processing Service: automation/servicetypes/data_processing.md
50-
- Data Validation Service: automation/servicetypes/data_validation.md
51-
- Generic File Transfer Service: automation/servicetypes/generic_filetransfer.md
52-
- Git Action Service: automation/servicetypes/git_action.md
53-
- ICMP TCP Ping Service: automation/servicetypes/icmptcp_ping.md
54-
- Mail Notification Service: automation/servicetypes/mail_notification.md
55-
- MatterMost Notification Service: automation/servicetypes/mattermost_notification.md
56-
- Napalm Service Common Parameters: automation/servicetypes/napalm_common.md
57-
- Napalm Configuration Service: automation/servicetypes/napalm_configuration.md
58-
- Napalm Data Backup Service: automation/servicetypes/napalm_databackup.md
59-
- Napalm Getters Service: automation/servicetypes/napalm_getters.md
60-
- Napalm Ping Service: automation/servicetypes/napalm_ping.md
61-
- Napalm Rollback Service: automation/servicetypes/napalm_rollback.md
62-
- Napalm Traceroute Service: automation/servicetypes/napalm_traceroute.md
63-
- Netconf (ncclient) Service: automation/servicetypes/netconf_ncclient.md
64-
- Netmiko Service Common Parameters: automation/servicetypes/netmiko_common.md
65-
- Netmiko Configuration Service: automation/servicetypes/netmiko_configuration.md
66-
- Netmiko Data Backup Service: automation/servicetypes/netmiko_databackup.md
67-
- Netmiko Filetransfer Service: automation/servicetypes/netmiko_filetransfer.md
68-
- Netmiko Prompts Service: automation/servicetypes/netmiko_prompts.md
69-
- Netmiko Commands Service: automation/servicetypes/netmiko_commands.md
70-
- Python Snippet Service: automation/servicetypes/python_snippet.md
71-
- REST Call Service: automation/servicetypes/rest_call.md
72-
- Scrapli Common Parameters: automation/servicetypes/scrapli_common.md
73-
- Scrapli Commands Service: automation/servicetypes/scrapli_command.md
74-
- Scrapli Data Backup Service: automation/servicetypes/scrapli_databackup.md
75-
- Scrapli Netconf Service: automation/servicetypes/scrapli_netconf.md
76-
- Slack Notification Service: automation/servicetypes/slack_notification.md
77-
- Topology Import Service: automation/servicetypes/topology_import.md
78-
- UNIX Command Service: automation/servicetypes/unix_command.md
79-
- UNIX Shell Script Service: automation/servicetypes/unix_shell.md
80-
- Workflow (subworkflow) Service: automation/servicetypes/workflow.md
81-
- Workflows:
82-
- Workflow Builder: automation/workflow_builder.md
83-
- Workflow Traversal: automation/workflow_traversal.md
84-
- Sharing Data between Services: automation/workflow_data.md
85-
- More Workflow Features: automation/workflow_more_features.md
86-
- Results: automation/results.md
87-
- Scheduling: automation/scheduling.md
46+
- Services:
47+
- Service Management: automation/services.md
48+
- Service Editor: automation/service_editor.md
49+
- Using Python in the Service Editor: automation/service_python_code.md
50+
- Service Types:
51+
- Service Type Index: automation/service_types.md
52+
- Ansible Playbook Service: automation/servicetypes/ansible_playbook.md
53+
- Data Processing Service: automation/servicetypes/data_processing.md
54+
- Data Validation Service: automation/servicetypes/data_validation.md
55+
- Generic File Transfer Service: automation/servicetypes/generic_filetransfer.md
56+
- Git Action Service: automation/servicetypes/git_action.md
57+
- ICMP TCP Ping Service: automation/servicetypes/icmptcp_ping.md
58+
- Mail Notification Service: automation/servicetypes/mail_notification.md
59+
- MatterMost Notification Service: automation/servicetypes/mattermost_notification.md
60+
- Napalm Service Common Parameters: automation/servicetypes/napalm_common.md
61+
- Napalm Configuration Service: automation/servicetypes/napalm_configuration.md
62+
- Napalm Data Backup Service: automation/servicetypes/napalm_databackup.md
63+
- Napalm Getters Service: automation/servicetypes/napalm_getters.md
64+
- Napalm Ping Service: automation/servicetypes/napalm_ping.md
65+
- Napalm Rollback Service: automation/servicetypes/napalm_rollback.md
66+
- Napalm Traceroute Service: automation/servicetypes/napalm_traceroute.md
67+
- Netconf (ncclient) Service: automation/servicetypes/netconf_ncclient.md
68+
- Netmiko Service Common Parameters: automation/servicetypes/netmiko_common.md
69+
- Netmiko Configuration Service: automation/servicetypes/netmiko_configuration.md
70+
- Netmiko Data Backup Service: automation/servicetypes/netmiko_databackup.md
71+
- Netmiko Filetransfer Service: automation/servicetypes/netmiko_filetransfer.md
72+
- Netmiko Prompts Service: automation/servicetypes/netmiko_prompts.md
73+
- Netmiko Commands Service: automation/servicetypes/netmiko_commands.md
74+
- Python Snippet Service: automation/servicetypes/python_snippet.md
75+
- REST Call Service: automation/servicetypes/rest_call.md
76+
- Scrapli Common Parameters: automation/servicetypes/scrapli_common.md
77+
- Scrapli Commands Service: automation/servicetypes/scrapli_command.md
78+
- Scrapli Data Backup Service: automation/servicetypes/scrapli_databackup.md
79+
- Scrapli Netconf Service: automation/servicetypes/scrapli_netconf.md
80+
- Slack Notification Service: automation/servicetypes/slack_notification.md
81+
- Topology Import Service: automation/servicetypes/topology_import.md
82+
- UNIX Command Service: automation/servicetypes/unix_command.md
83+
- UNIX Shell Script Service: automation/servicetypes/unix_shell.md
84+
- Workflow (subworkflow) Service: automation/servicetypes/workflow.md
85+
- Workflows:
86+
- Workflow Builder: automation/workflow_builder.md
87+
- Workflow Traversal: automation/workflow_traversal.md
88+
- Sharing Data between Services: automation/workflow_data.md
89+
- More Workflow Features: automation/workflow_more_features.md
90+
- Results: automation/results.md
91+
- Scheduling: automation/scheduling.md
8892
- Advanced:
89-
- Search System: advanced/search_system.md
90-
- Workflow and Service Design:
91-
- Service Selection: advanced/service_selection.md
92-
- Recommended Practices: advanced/recommended_practices.md
93-
- REST API:
94-
- Start here: advanced/endpoint_type_index.md
95-
- Retrieve an instance: advanced/endpoint_types/retrieve_instance.md
96-
- Delete an instance: advanced/endpoint_types/delete_instance.md
97-
- Create or update an instance: advanced/endpoint_types/create_update_instance.md
98-
- Retrieve a list of instances - simple: advanced/endpoint_types/retrieve_list_instance_simple.md
99-
- Retrieve a list of instances - custom: advanced/endpoint_types/retrieve_list_instance_custom.md
100-
- Run a service: advanced/endpoint_types/run_service.md
101-
- Get status or results of service: advanced/endpoint_types/results_service.md
102-
- Retrieve device configuration: advanced/endpoint_types/device_config.md
103-
- Migrate between applications: advanced/endpoint_types/migrate.md
104-
- Get worker stats: advanced/endpoint_types/workers.md
105-
- Ping application: advanced/endpoint_types/ping.md
106-
- Administrative: advanced/endpoint_types/admin.md
107-
- CLI Commands: advanced/cli_commands.md
108-
- Customization: advanced/customization.md
109-
- Contributing: advanced/contributing.md
93+
- Search System: advanced/search_system.md
94+
- Workflow and Service Design:
95+
- Service Selection: advanced/service_selection.md
96+
- Recommended Practices: advanced/recommended_practices.md
97+
- REST API:
98+
- Start here: advanced/endpoint_type_index.md
99+
- Retrieve an instance: advanced/endpoint_types/retrieve_instance.md
100+
- Delete an instance: advanced/endpoint_types/delete_instance.md
101+
- Create or update an instance: advanced/endpoint_types/create_update_instance.md
102+
- Retrieve a list of instances - simple: advanced/endpoint_types/retrieve_list_instance_simple.md
103+
- Retrieve a list of instances - custom: advanced/endpoint_types/retrieve_list_instance_custom.md
104+
- Run a service: advanced/endpoint_types/run_service.md
105+
- Get status or results of service: advanced/endpoint_types/results_service.md
106+
- Retrieve device configuration: advanced/endpoint_types/device_config.md
107+
- Migrate between applications: advanced/endpoint_types/migrate.md
108+
- Get worker stats: advanced/endpoint_types/workers.md
109+
- Ping application: advanced/endpoint_types/ping.md
110+
- Administrative: advanced/endpoint_types/admin.md
111+
- CLI Commands: advanced/cli_commands.md
112+
- Customization: advanced/customization.md
113+
- Contributing: advanced/contributing.md
110114
theme:
111115
name: material
116+
custom_dir: theme_overrides
112117
features:
113118
- navigation.expand
114119
- navigation.instant
@@ -129,8 +134,8 @@ extra:
129134
link: mailto://contact@enms.io
130135
generator: false
131136
no_auto_expand:
132-
- "Service Types"
133-
- "REST API"
137+
- 'Service Types'
138+
- 'REST API'
134139
extra_javascript:
135140
- https://code.jquery.com/jquery-2.2.4.min.js
136141
- https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
683 Bytes
14.4 KB
12.4 KB
35.8 KB
24.2 KB
32.5 KB
84 KB
44.3 KB
-10 KB

0 commit comments

Comments
 (0)