hypernode-docs-next

Generating new docs

DOC_URL=https://support.hypernode.com/en/ecommerce/magento-1/how-to-enable-mysql-query-logging-for-magento-1-x
bin/download_doc --output-dir=docs/ecommerce-applications $DOC_URL

Setting up the project

mkvirtualenv hypernode-docs-next
echo "export PYTHONPATH=$(pwd)" >> $VIRTUAL_ENV/bin/postactivate
workon hypernode-docs-next
pip install -r requirements/development.txt
pre-commit install

Building the docs

bin/build_docs

Serving the docs

bin/serve_docs

Setup Frontend step by step

clone the repository
pip install -r requirements/development.txt
bin/build_docs
bin/serve_docs

in another terminal run bin/watch

open localhost and now you can make changes in style and refresh the page without rebuilding

when you're working on scss to compile it automatically run

sass --watch docs/_static/scss:docs/_static/css

or after changes compile scss once:

sass docs/_static/scss:docs/_static/css

Deployment

Deploys automatically after merging branchers to master.

Deploy with Hypernode Deploy

To deploy to a local Hypernode Docker environment:

$ docker pull docker.hypernode.com/byteinternet/hypernode-buster-docker:latest
$ docker run docker.hypernode.com/byteinternet/hypernode-buster-docker:latest
$ # Note the IP address, it should be 172.17.0.2 (otherwise refer to deploy.php)

Next make sure your ~/.ssh/yourdeploykey equivalent can log in to the Docker host (172.17.0.2) as the app user. You can add it to the /data/web/.ssh/authorized_keys file on in the instance manually.

Then deploy to your local Hypernode Docker:

docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build quay.io/hypernode/deploy:latest hypernode-deploy build -vvv  # First build the artifact
docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build quay.io/hypernode/deploy:latest hypernode-deploy deploy docker -vvv  # Then perform the deploy

Building the manpage deb

The docs are also packaged as a debian package named hndocsnext so that on a Hypernode you can run man hypernode (or hypernode-manual) and page through a manpage version of the Hypernode docs. To build that debian package on a Debian machine you can run these commands:

# First create the cow environment
export ARCH=amd64
export DIST=buster
apt-get install debhelper cowbuilder git-buildpackage
cowbuilder --create --distribution buster --architecture amd64 --basepath /var/cache/pbuilder/base-$DIST-amd64.cow --mirror http://ftp.debian.org/debian/ --components=main

# We need to make sure our build process can use networking in order to pip install the requirements
echo "USENETWORK=yes" > ~/.pbuilderrc

# Then clone the repository and build the .deb
git clone https://github.com/ByteInternet/hypernode-docs-next
cd hypernode-docs-next
gbp buildpackage --git-pbuilder --git-dist=$DIST --git-arch=$ARCH --git-ignore-branch -us -uc -sa --git-ignore-new

Then after building the Deb you could install it with dpkg. For example:

dpkg -i ../hndocsnext_20230121.173551_all.deb

And test it out with:

man hypernode

To inspect the contents of the deb archive you can run:

# dpkg -L hndocsnext
/.
/usr
/usr/local
/usr/local/man
/usr/local/man/man3
/usr/local/man/man3/hypernode.3
/usr/share
/usr/share/doc
/usr/share/doc/hndocsnext
/usr/share/doc/hndocsnext/README.md
/usr/share/doc/hndocsnext/changelog.gz