zimoch/Controls-docs
0
0
Fork 0
forked from Controls/gitea-pages
Code Pull Requests Actions Activity

it should get the TOC from the global _toc.yaml...

Browse Source
This commit is contained in:
buchel_k
2023-05-10 16:18:04 +02:00
parent f1e638b123
commit 860814153d
2 changed files with 24 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
admin-guide/guidelines.rst
+24 -7
View File
@@ -1,11 +1,6 @@
Guidelines
==========
.. toctree::
:maxdepth: 1
guidelines/conventions
Version Control
---------------
@@ -51,6 +46,7 @@ has to avoid as much as possible dependency from external services availability.
A WAN outage or a remote http server failure should not influence the installation system.
For this reason, all the external code is mirrored internally in specific git repositories.
Servers and services
--------------------
@@ -66,5 +62,26 @@ Development Workflow
The general inspiration comes from `this post
<http://nvie.com/posts/a-successful-git-branching-model/>`_.
Regarding the puppet code this is more detailed description of our current
workflow:
Naming convention for servers
-----------------------------
Server names have the form ``lx-purpose-[0-9][0-9].psi.ch``, where
``purpose`` is the purpose of the server or the service provided by it. Examples are:
- ``lx-boot-01.psi.ch`` is the **boot** server
The production server always has an DNS alias `purpose.psi.ch` and clients should always use this alias to connect to the server.
When putting system names into configuration files, we always use lower case and
the fully qualified domain name. Good: ``boot.psi.ch``.
Names for programs
------------------
The general conventions regarding filenames apply (see `File system hierarchy
and filenames`_). In addition, scripts should not include a suffix indicating
the language they are written in. The latter is an implementation detail and
does not matter to the caller of the script/program. A good name could be
``pli-system-info``, a bad one would be ``pli-system-info.sh``.
admin-guide/guidelines/conventions.rst
-26
View File
@@ -1,26 +0,0 @@
Conventions
===========
Naming convention for servers
-----------------------------
Server names have the form ``lx-purpose-[0-9][0-9].psi.ch``, where
``purpose`` is the purpose of the server or the service provided by it. Examples are:
- ``lx-boot-01.psi.ch`` is the **boot** server
The production server always has an DNS alias `purpose.psi.ch` and clients should always use this alias to connect to the server.
When putting system names into configuration files, we always use lower case and
the fully qualified domain name. Good: ``boot.psi.ch``.
Names for programs
------------------
The general conventions regarding filenames apply (see `File system hierarchy
and filenames`_). In addition, scripts should not include a suffix indicating
the language they are written in. The latter is an implementation detail and
does not matter to the caller of the script/program. A good name could be
``pli-system-info``, a bad one would be ``pli-system-info.sh``.