shinnlok / deps.cloud

Source for the deps.cloud website, blog, and documentation.

deps.cloud documentation

This repository contains the source for the deps.cloud website, blog, and documentation.

Prerequisites

In order to use this repository, you will need the following installed locally.

• npm
• Hugo

Before you start, clone the repository and install dependencies.

git clone [email protected]:depscloud/deps.cloud.git
cd deps.cloud
make deps

Running the website locally

Once you've installed the dependencies, you can run a local server.

hugo serve -D

This will start up a server on localhost:1313. You should be able to see any changes made to documentation updated in realtime in the browser.

Contributing a change

Before getting started, take a look at our contributing guidelines and project board.

When contributing a change, you should submit a pull request from a fork. Your fork can be added as a remote to the upstream repository. This will be the easiest way to stay on top of the latest changes.

git remote add [username] [email protected]:[username]/deps.cloud.git

All modifications should be commit to a branch. When a GitHub issue exists for the work you're contributing, you should associate you're branch appropriately. Otherwise, a simple, descriptive name is sufficient (e.g. ci_update.)

git checkout -b gh-###

Pushing changes to a fork

When you're ready to submit a pull request, your changes should be pushed to your fork. From there, you can submit a merge request back to a company.

git push -u [username] gh-###

Support

Join our mailing list to get access to virtual events and ask any questions there.

We also have a Slack channel.

Code of Conduct

deps.cloud is governed by the Contributor Covenant v1.4.1.

License Checks