Skip to content
This repository has been archived by the owner on Sep 8, 2023. It is now read-only.

feat: added versioning for docs #84

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
![Readme-banner](./static/img/docs-banner-tw.png#gh-dark-mode-only)
![Readme-banner](./static/img/docs-banner-tw-light.png#gh-light-mode-only)

<h1>Official Komiser Documentation</h1>
<p>
This is the repository for the Tailwarden Organization Public Documentation. It is the official Tailwarden site for publishing latest news, blog posts, and documentation from our open source community.
</p>

</div>

## Contribution Steps

1. **Fork this repository**: Go to `https://github.com/repository-owner/docs.komiser.io` and click the "Fork" button in the top-right corner to create a fork of the repository on your GitHub account.

2. **Clone your forked repo**: Open your terminal and use the following command to clone your forked repository to your local machine:

```
git clone "https://github.com/github-username/docs.komiser.io.git"
```

3. **Create a documentation branch**: Switch to a new branch to work on your documentation changes:

```
git checkout -b branch-name
```

4. **Make changes to the documentation**: Navigate to the `docs` folder and make the necessary updates to the documentation files.

5. **Run the command to publish version**: Execute the following command and enter the next release version in the prompt, following the Semantic Versioning format (e.g., `1.0.0`, `1.1.0`, etc.):

```
npm run publish-version
```

6. **Add changes to the staging area**: Add your changes to the staging area in preparation for commit:

```
git add .
```

7. **Commit your changes**: Commit your changes with a meaningful commit message describing the updates made:

```
git commit -m 'Your commit message here'
```

8. **Push your changes to GitHub**: Push the changes to your GitHub repository:

```
git push origin branch-name
```

9. **Create a new Pull Request**: Go to your GitHub repository, switch to the new branch, and click the "New Pull Request" button. Submit the Pull Request to the main repository for review and merging.

## Contribution Guidelines

Please ensure your changes adhere to our contribution guidelines (link to CONTRIBUTING.md or guidelines page). Your Pull Request will be reviewed by our maintainers, and any necessary feedback or changes may be requested before merging.

Thank you for contributing to our project! We appreciate your support and efforts in improving the documentation.

---
73 changes: 56 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,65 @@ This is the repository for the Tailwarden Organization Public Documentation. It

</div>

### How to Run Locally
## How to Run Locally

1. Clone this repository: `git clone "https://github.com/tailwarden/docs.komiser.io.git"`
2. Run the commands :
1. `npm install`
2. `npm run build`
3. `npm run start`
3. The site will be running locally on `http://localhost:3000`
Follow these steps to run the project locally on your machine:

### How To Contribute To the Documentation
1. **Clone this repository**: Open your terminal and use the following command to clone the repository to your local machine:

1. Fork this repository
2. Create your documentation branch: `git checkout -b branch-name`
3. Make changes to the documentation in markdown
4. Add changes to the staging area `git add .`
5. Commit your changes using the command `git commit -m 'commit message'`
6. Push your changes to gitHub `git push origin branch-name`
7. Create new Pull Request
```
git clone "https://github.com/tailwarden/docs.komiser.io.git"
```

2. **Install dependencies and build**: Run the following commands one after another to install the project dependencies and build the application:

## History
```
npm install
npm run build
```

### v1.0.0 (Aug, 2022)
3. **Start the local server**: Finally, start the local development server with the following command:

```
npm run start
```

4. **Access the site locally**: Once the server starts, you can access the website locally in your web browser at `http://localhost:3000`.

## How to Contribute to the Documentation

We welcome contributions to improve our documentation. Follow these steps to make a contribution:

1. **Fork this repository**: Click the "Fork" button at the top-right of this page to create a fork of the repository on your GitHub account.

2. **Create a documentation branch**: Switch to a new branch to work on your documentation changes:

```
git checkout -b branch-name
```

3. **Choose the version**: Locate the version you want to contribute to in the `version_docs` folder.

4. **Make changes to the documentation**: Edit the documentation in Markdown format for the particular version.

5. **Add changes to the staging area**: Add your changes to the staging area in preparation for commit:

```
git add .
```

6. **Commit your changes**: Commit your changes with a meaningful commit message describing the updates made:

```
git commit -m 'Your commit message here'
```

7. **Push your changes to GitHub**: Push the changes to your GitHub repository:

```
git push origin branch-name
```

8. **Create a new Pull Request**: Go to your GitHub repository, switch to the new branch, and click the "New Pull Request" button. Submit the Pull Request to the main repository for review and merging.

Thank you for contributing to our documentation! Your efforts help make our project better for everyone.
Loading