This document is capturing discussions at the Server SoC HW TG. This is not an official specification and everything in this document may change.
This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0). For details, see the LICENSE file.
The list of contributors to this specification is maintained in the contributors file.
For guidelines on how to contribute, refer to the CONTRIBUTING file.
The following directories are used to organize the contents of this repo:
-
dependencies/: software dependencies needed to build the specification -
docs-resources/: resources for all specifications sourced from git submodule -
src/: source files for the specification -
build/: default directory where the build artifacts are generated
To build the document, you’ll need the following tools installed on your system:
-
Make
-
asciidoctor, asciidoctor-pdf, asciidoctor-bibtex, asciidoctor-diagram, and asciidoctor-mathematical
-
Docker
git clone --recurse-submodules https://github.com/riscv-non-isa/server-soc.gitTo start the build process, run:
cd ./server-soc && make buildThe Makefile script will check the availability of Docker on your system:
-
If Docker is available, the documentation will be built inside a Docker container using the image riscvintl/riscv-docs-base-container-image:latest. This ensures a consistent build environment across different systems.
-
If Docker is not available, the documentation will be built directly on your system using the installed tools.
The documentation is generated from the AsciiDoctor source files in your project. The primary source file is specified by the HEADER_SOURCE variable in the Makefile.
The build process utilizes several options, including theming and font settings, and generates a PDF document as output.
The repository has some basic commit checks set up with pre-commit that will be enforced by the GitHub CI. To ensure these checks are also run in the local repository while making changes the following command can be run:
pip3 install pre-commit && pre-commit installWhen enabling additional checks by editing .pre-commit-config.yaml, it is recommended to run to newly added check on all files in the repository. This can be done with the following command:
pre-commit run --all-files
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent