This repo has files from webcivics discord projects.
Web Civics Discord Server Link
Welcome to the Collaborative Markdown Projects repository! This repository is designed to store markdown files for various projects collaboratively developed through Discord. Our goal is to streamline the process of collaborative documentation and ensure all contributions are properly managed and stored on GitHub.
- Introduction
- Getting Started
- Workflow
- File Structure
- Contribution Guidelines
- License
- Acknowledgements
This repository serves as a centralized location for markdown documents produced from collaborative efforts on Web Civics projects via Discord. The notion of using a Github Repo, is to support version-controlled project documentation in a way that can help us better collaborate.
Not all projects can be stored within this repo, as some projects have alot of data assocaited to them. In those cases, this repo will provide links to the resources associated with those projects.
This document has been largely generated via the use of ChatGPT. It will be edited and improved upon, but the basic outline is that there should be separate folders that associate with a discord channel; and that, a minimum of a readme.md file be created in that folder. Larger projects should be supported either via a seperate github repo, where the information in this repo provides links to that repo; or, a separate github account if the project is bigger.
Projects that are not incubated or established by / via Web Civics community works, can be linked and collaborative works on those projects is welcomed, but, any such activities should be supportive of the project owners, provide the authorised links to the project owners / communities resources, and any contributing work done via web-civics related supports; should consider and respect the 'web civics' ethos, generally and certainly not act to breach it.
Projects might evolve to develop to become complex, with many different 'threads', components or linked-projects. Should this occur, a separate category may be created in the web civics discord server; or, a separate server, as is the case for some projects already today.
Before you begin, ensure you have the following installed on your local machine:
- Git
- A GitHub account
- Access to the relevant Discord server
- Fork the Repository: Fork this repository to your own GitHub account by clicking the "Fork" button at the top right of this page.
- Clone the Repository: Clone the forked repository to your local machine using the following command:
git clone https://github.com/YOUR_USERNAME/collaborative-markdown-projects.git
- Navigate to the Directory: Change into the repository directory:
cd collaborative-markdown-projects
- Join the Discussion on Discord: Participate in project discussions and collaborations on our Discord server. Markdown files can be collaboratively edited using Discord channels dedicated to each project.
- Edit Markdown Files Locally: Make changes or add new markdown files on your local machine.
- Commit Changes: Once you have made your changes, commit them with a meaningful message:
git add . git commit -m "Add/update project documentation for [Project Name]"
- Push Changes: Push your changes to your forked repository:
git push origin main
- Create a Pull Request: Go to the original repository on GitHub and create a pull request from your forked repository.
markdown Copy code
Welcome to the Collaborative Markdown Projects repository! This repository is designed to store markdown files for various projects collaboratively developed through Discord. Our goal is to streamline the process of collaborative documentation and ensure all contributions are properly managed and stored on GitHub.
- Introduction
- Getting Started
- Workflow
- File Structure
- Contribution Guidelines
- License
- Acknowledgements
This repository serves as a centralized location for markdown documents produced from collaborative efforts on Discord. Whether it's brainstorming sessions, project planning, documentation, or any other written content, we ensure that all markdown files are easily accessible, organized, and version-controlled.
Before you begin, ensure you have the following installed on your local machine:
- Git
- A GitHub account
- Access to the relevant Discord server
- Fork the Repository: Fork this repository to your own GitHub account by clicking the "Fork" button at the top right of this page.
- Clone the Repository: Clone the forked repository to your local machine using the following command:
git clone https://github.com/YOUR_USERNAME/collaborative-markdown-projects.git
- Navigate to the Directory: Change into the repository directory:
cd collaborative-markdown-projects
- Join the Discussion on Discord: Participate in project discussions and collaborations on our Discord server. Markdown files can be collaboratively edited using Discord channels dedicated to each project.
- Edit Markdown Files Locally: Make changes or add new markdown files on your local machine.
- Commit Changes: Once you have made your changes, commit them with a meaningful message:
git add . git commit -m "Add/update project documentation for [Project Name]"
- Push Changes: Push your changes to your forked repository:
git push origin main
- Create a Pull Request: Go to the original repository on GitHub and create a pull request from your forked repository.
collaborative-markdown-projects/ ├── project-1/ │ ├── README.md │ ├── docs/ │ │ ├── introduction.md │ │ └── overview.md ├── project-2/ │ ├── README.md │ ├── docs/ │ │ ├── requirements.md │ │ └── architecture.md └── README.md
- Each project will have its own directory.
- Each project directory contains a
README.mdfile and adocssubdirectory for detailed markdown files.
We welcome contributions from everyone! Here are some guidelines to help you get started:
- Be Respectful: Treat everyone with respect. We're all here to learn and grow together.
- Follow the Workflow: Stick to the workflow outlined above to ensure consistency.
- Write Clear Commit Messages: Use clear and concise commit messages to describe your changes.
- Review Pull Requests: Participate in reviewing pull requests to help maintain the quality of the documentation.
One of the many Web Civics projects is to address digital slavery, which in-part requires a process of producing tools that enable the means to compensate people fairly for their works whilst thereby supporting the release of derivatives as obligation free software or derivatives once obligations are fairly met.
Once these works have matured, consideration about how to append licensing considerations will be made. For now, all rights shared fairly.
We appreciate the contributions and efforts of everyone participating in this collaborative project. Special thanks to the Discord community for their continuous support and collaboration.
Feel free to reach out with any questions or suggestions. Happy documenting!