Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Contribution Guideline #102

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added Contribution Guideline #102

wants to merge 2 commits into from

Conversation

DaintyJet
Copy link
Contributor

@DaintyJet DaintyJet commented Nov 12, 2024

Overview of Changes

I updated the readme and added a basic contribution guideline.

Reason for Modification

This is required.

Verification

  • The documentation is completed, or does not contain work-in-progress/partially-completed sections.
  • The documentation is written in Markdown (Exception for Inject and Incident Reports).
  • Any Images are contained in a subdirectory Images.
  • Any scripts, Ansible Playbooks, Terraform scripts, etc. Have documentation explaining their purpose and use case.
  • Any scripts are tested.
  • I have assigned and notified a reviewer.

@DaintyJet DaintyJet added the documentation Improvements or additions to documentation label Nov 12, 2024
@DaintyJet DaintyJet requested a review from a team as a code owner November 12, 2024 17:30
@DaintyJet DaintyJet linked an issue Nov 12, 2024 that may be closed by this pull request
Copy link

@rohan-ap457 rohan-ap457 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems good to me~!

This repository contains notes on various services and platforms in the [OperatingSystem-Services](./OperatingSystem-Services/) directory, some in-progress or completed projects using those technologies are contained in the [Projects](./Projects/) directory. Notes for the administration of our resources, mainly the creation of practice events, tasks, and infrastructure related tasks are contained in the [Admin](./Admin/) directory. The expected workflows are contained in the [Admin/Task-Management-Workflow](./Admin/Task-Management-Workflow/) directory, and limited event notes are contained in [Event-Notes](./Event-Notes/).

## Table of Contents (README) <!-- omit from toc -->
- [Accessing Infrastructure](#accessing-infrastructure)
- [Table of Contents (TOPICS)](#table-of-contents-topics)
- [OpenProject](#openproject)

## Accessing Infrastructure
1. Connect to the OpenVPN server using your certificate. This requires the [OpenVPN Client](https://openvpn.net/client/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are no longer using OpenVPN, but Wireguard.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should not have deleted the OpenProject thing, this all can be part of a separate commit and whatnot

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also some people are still using OpenVPN, for some Wireguard does not work, so probably better to list both?


## Guidelines and Procedure
> [!IMPORTANT]
> If you make a branch it should be *focused* that is we should keep the changes in that branch to specific technology or set of files. You should not be updating Windows, AWS and Linux documents unless you are working with a technology that uses all three of those things. In that case it may be a good idea for the technology (such as Wazuh) to be in it's own folder.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you a outline a naming convention for branches?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a contributions guide
3 participants