Cockroach documentation

11:37 10/09/2021: instructions et notes, cafard docu alpha

Ceci est juste un site Web Barebone, il doit d'abord être rempli de documentation de la version C ++ de cafard. GitHub Repo doit être structuré avec Cmake.

---

Installez Jekyll sur Win Machine localement

Cloner le repo. Et installer Jekyll / Ruby pour WIN, suivez le lien ici. Plus de documentation sur Jekylls ici

Utilisez Jekyll sur Win Machine

Accédez au répertoire de la documentation.

Si vous utilisez le Ruby Gems v 3.0.0, le «webrick» n'en est pas expédié. Vous devez l'ajouter manuellement une fois l'installation de Ruby Wizard.

$ bundle add webrick

Ouvrez le projet sur VSCODE et ouvrez un nouveau CMD qui pointe vers le répertoire local du repo cloné. Si vous êtes sur IBOIS Server, vous devez taper ce CMD:

$ pushd \ enac1files I BOIS n ame-folder

Une fois Jekyll installé et que le projet VScode est prêt, vous pouvez exécuter Jekyll localement. Notez que pour rendre les modifications efficaces, ils doivent être poussés vers le repo GitHub en ligne.

$ bundle exec jekyll serve --trace

Dépannage

Les documents de cafards fonctionnent sur la version 2.3.4 de Bundle. Si vous recevez une erreur que le bundle ne correspond pas à forcer le bundle d'installation en exécutant cela dans la console:

 gem install bundler:2.1.4
bundle _2.1.4_ install 

---

Choses à ajouter:

• Répo du code GitHub C ++ du cafard
• C ++ cafard docu
• Google Analytics intégré pour suivre les vues et les documentations qui sont les plus utiles
• Le domaine DNS fait pour la garde (www.cockroach.com)

Tutoriels

• Tutoriel Jekyll