From 62137a0f8fbcd6b3e43c4df9c653bf079ae6cd99 Mon Sep 17 00:00:00 2001 From: Lee Calcote Date: Sun, 13 Oct 2024 19:29:57 -0500 Subject: [PATCH] Update CONTRIBUTING.md Signed-off-by: Lee Calcote --- CONTRIBUTING.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 00417cc3..d254b26e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,22 +50,6 @@ Or you may configure your IDE, for example, Visual Studio Code to automatically -## Documentation Contribution Flow -Please contribute! Layer5 documentation uses Jekyll and GitHub Pages to host docs sites. Learn more about [Layer5's documentation framework](https://docs.google.com/document/d/17guuaxb0xsfutBCzyj2CT6OZiFnMu9w4PzoILXhRXSo/edit?usp=sharing). The process of contributing follows this flow: - -1. Create a fork, if you have not already, by following the steps described [here](./CONTRIBUTING-gitflow.md) -1. In the local copy of your fork, navigate to the docs folder. -`cd docs` -1. Create and checkout a new branch to make changes within -`git checkout -b ` -1. Edit/add documentation. -`vi .md` -1. Run site locally to preview changes. -`make site` -1. Commit, [sign-off](#commit-signing), and push changes to your remote branch. -`git push origin ` -1. Open a pull request (in your web browser) against the repo. - #### Tests Users can now test their code on their local machine against the CI checks implemented using `make run-tests`. @@ -92,7 +76,7 @@ All contributors are invited to review pull requests. See this short video on [h Resources: https://lab.github.com and https://try.github.com/ -# FQA +# FAQs ### Instructions for making custom dictionary entries