Website: https://docs-dang.it/
CloudFest 2023 Hackathon project
This repo contains the frontend code for the project website. Code for the backend is in docs_dangit-the-beast repo.
- Jessica Lyschik - https://github.com/luminuu - design/frontend
- Dhanuka Nuwan - https://github.com/dhanukanuwan - frontend
- Sven Wagener - https://github.com/mahype - parser/backend
- David Beja - https://github.com/dbeja - parser/backend
- Andreas Heigl - https://github.com/heiglandreas - data/storage
- Kevin Batdorf - https://github.com/KevinBatdorf - devOps/frontend
- Karsten Frohwein - https://github.com/kfrohwein - parser/backend
- Aleksandar Savković - https://profiles.wordpress.org/wpaleks/ - social/presentation
- Luke Carbis - https://github.com/lukecarbis - frontend
- Milana Cap - https://github.com/zzap - docs/DNS
Sources are listed below in the order they have been added to the project.
The Code reference handbook is partly generated from the code. Most of the code samples are in the User Contributed Notes section, which are comments (example).
URL: https://developer.wordpress.org/reference/
We use wp cli cmd-dump to export all commands in a giant JSON file which is stored in the GitHub repo. GitHub action is doing this automatically once a day at 6AM.
URL: https://github.com/wp-cli/handbook/tree/main/commands
Official PHP documentation, hosted on https://github.com/php/doc-en.
URL: https://www.php.net/docs.php
Every WordPress release is accomanied with a number of dev notes in Core blog. These notes are packed with useful code examples.
URL: https://make.wordpress.org/core/tag/dev-notes/
Parsers are built on top of Symfony Console component. At the moment of building the tool (CloudFest hackathon 2023), there are two parsers:
Storage is in mySQL with a full-text index and a small API built with Laminas and Mezzio frameworks. API is private for now but could be made public in the future given the proper setup and storage financing is provided.
- Code snippet - the snippet extracted from the source.
- Context - the whole data chunk, e.g. comment
- Parse date - the date source was parsed.
- URL - URL of the source.
- Code creator - author of the snippet (if available).
- Code creation datetime - the date of source creation (if available), e.g. comment date.
- Source - the source of the snippet, e.g. wpcli, wp-reference, wp-reference-comment etc.
- Version - source version, e.g. WP 6.2, WP-CLI 2.7 etc.
- Command tags - the command/function found in the snippet, e.g. update_term_meta.
- Tags - general taxonomy based on various criteria, e.g. WordPress (based on CMS), Laravel (based on the framework) etc.
- Language - IETF language tag of the source, e.g. en-US.
- Codelang tags - Tag for the code language, e.g. PHP, JavaScript etc.
Create the Key and Cert for a Certification authority by calling the following commands on the CLI:
cd /path/to/backend/.docker/nginx/
openssl genrsa -out ssl/ca.key 4096;
openssl req -x509 -new -nodes -subj "/C=de/O=docs/CN=development certificates;" -key ssl/ca.key -sha512 -days 3650 -out ssl/ca.crt;This will create the necessary files. You should import the CRT file as certification authority into your browser to not get remarks that the website might be insecure.
With a working docker-setup you can start the development environment via docker compose up -d.
This should download and create all the necessary information to get up and running.
You should also add the line 127.17.0.1 docs.dangit to your /etc/hosts file to be able to resolve the docs.dangit
development website
Then you can point your browser to https://docs.dangit and enjoy
Frontend is built on React.js with Tailwind CSS.
docs_dangit is a free software, and complete code inside it is released under the terms of the GNU General Public License version 3 or later. This does not apply to Google fonts and other 3rd party assets - their original license applies.
by Cloudfest Hackathon Cool Kids