diff --git a/content/en/_index.md b/content/en/_index.md index a81113f..96883e9 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -1,7 +1,7 @@ --- title: "Open-Set-Go" -description: "'Project Starting Toolkit' for open SW developers who can easily and easily start an Open Source project" -lead: "'Project Starting Toolkit' for open SW developers who can easily and easily start an Open Source project" +description: "'The Open-Source Management Platform' for Open-Source Developers that provides the creation of new open-source projects and operational review for existing projects." +lead: "'The Open-Source Management Platform' for Open-Source Developers that provides the creation of new open-source projects and operational review for existing projects." date: 2020-10-06T08:47:36+00:00 lastmod: 2023-08-28T20:05:20+00:00 draft: false diff --git a/content/en/docs/guideForClient/Recommandation/_index.md b/content/en/docs/guideForClient/Recommandation/_index.md new file mode 100644 index 0000000..3dd190b --- /dev/null +++ b/content/en/docs/guideForClient/Recommandation/_index.md @@ -0,0 +1,13 @@ +--- +title: "Recommandation" +description: "" +lead: "" +date: 2020-10-06T08:49:15+00:00 +lastmod: 2020-10-06T08:49:15+00:00 +draft: false +menu: + docs: + parent: "guideForClient" +images: [] +weight: 350 +--- diff --git a/content/en/docs/guideForClient/Recommandation/community.md b/content/en/docs/guideForClient/Recommandation/community.md new file mode 100644 index 0000000..ed49f38 --- /dev/null +++ b/content/en/docs/guideForClient/Recommandation/community.md @@ -0,0 +1,34 @@ +--- +title: "Community" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + guideForClient: + parent: "Recommandation" +weight: 100 +toc: true +--- +### Slack +- Slack is an enterprise messaging app that connects people and information. +- Slack can improve how organizations communicate by bringing people together and running a unified team. +- You can communicate with your team, as well as create and use channels as a community or for various purposes. +{{< alert icon="πŸ‘‰" >}} Want to try Slack as a community or learn more about Slack? [Quickstart for Slack](https://slack.com/intl/en-gb/help/articles/360059928654-How-to-use-Slack--your-quick-start-guide) {{< /alert >}} + +### Connect Slack and GitHub +- In addition, you can connect Slack and GitHub, so you can receive notifications such as GitHub Puliquet and Issue. +{{< alert icon="πŸ‘‰" >}} If you want to connect Slack and GitHub? [How to connect Slack to GitHub](https://slack.github.com/) {{< /alert >}} + +### Discord +- Discord is a place where you can feel a bond by belonging to the community and more easily, hang out and talk every day. +- Discord servers are divided into topic-based channels, so you can cooperate, share, and talk comfortably in a group room without congestion. +- You are given administrative tools that can be run by any community, and you can also specify the members' permissions. +{{< alert icon="πŸ‘‰" >}} Want to try Discord as a community or learn more about Discord? [Discord Guide for Beginners](https://support.discord.com/hc/ko/articles/360045138571-Discord-%EC%B4%88%EB%B3%B4%EC%9E%90%EB%A5%BC-%EC%9C%84%ED%95%9C-%EC%95%88%EB%82%B4%EC%84%9C) {{< /alert >}} + +### GitHub Discussion +- GitHub Discussions is a joint communication forum for the community around open source or internal projects. +- Community members can ask questions, answer questions, share updates, have open conversations, and follow decisions that affect how the community works. +{{< alert icon="πŸ‘‰" >}} Want to try GitHub Discussions as a community or learn more about GitHub Discussions? [Quickstart for GitHub Discussions](https://docs.github.com/en/discussions/quickstart) {{< /alert >}} \ No newline at end of file diff --git a/content/en/docs/guideForClient/Recommandation/tool.md b/content/en/docs/guideForClient/Recommandation/tool.md new file mode 100644 index 0000000..cf38b88 --- /dev/null +++ b/content/en/docs/guideForClient/Recommandation/tool.md @@ -0,0 +1,36 @@ +--- +title: "Tool" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + guideForClient: + parent: "Recommandation" +weight: 120 +toc: true +--- +### Sonar Cloud +- Sonar Cloud is a tool that easily integrates into the cloud DevOps platform and uses code review tools that extend CI/CD workflows when teams want to deliver clean code consistently and efficiently. +{{< alert icon="πŸ‘‰" >}} What is SonarCloud? [Sonarcloud Document](https://docs.sonarcloud.io/) {{< /alert >}} +{{< alert icon="πŸ‘‰" >}} How to use SonarCloud? [Quickstart for Slack](https://www.sonarsource.com/products/sonarcloud/?gads_campaign=SC-Hroi-Brand&gads_ad_group=SonarCloud&gads_keyword=sonarcloud&gclid=CjwKCAjw3dCnBhBCEiwAVvLcuw2gx3ghQq_AFOWEksB18wXgY-66606OoWOKfSpEnAmJ-RbUW-FAxRoC8P8QAvD_BwE) {{< /alert >}} + +### GitHub Actions +- Automate, customize, and run software development workflows directly from the repository using GitHub Actions. You can discover, create, and share tasks to accomplish the desired tasks, including CI/CD, and combine them in fully customized workflows. +{{< alert icon="πŸ‘‰" >}} How to use GitHub Actions? [Quickstart for GitHub Actions](https://docs.github.com/en/actions/quickstart) {{< /alert >}} + +### FOSSA +- FOSSA protects code by mitigating open source risk. +- Software protection against open source risk management and license violations, vulnerabilities, and supply chain threats. + +βœ… License Identification
+βœ… Manage 5 Projects
+βœ… Vulnerability Management
+βœ… Basic Teams / Roles +{{< alert icon="πŸ‘‰" >}} How to use FOSSA? [Quickstart for FOSSA](https://docs.fossa.com/docs/getting-started) {{< /alert >}} + +### Dependabot +- Dependabot creates Dependabot alerts when a known vulnerability is detected in the dependencies used by the project. +{{< alert icon="πŸ‘‰" >}} How to use Dependabot? [Quickstart for GitHub Actions](https://docs.github.com/ko/enterprise-server@3.6/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions) {{< /alert >}} \ No newline at end of file diff --git a/content/en/docs/guideForClient/_index.md b/content/en/docs/guideForClient/_index.md new file mode 100644 index 0000000..bb7e2f8 --- /dev/null +++ b/content/en/docs/guideForClient/_index.md @@ -0,0 +1,10 @@ +--- +title: "Guide For Client" +description: "" +lead: "" +date: 2020-10-06T08:49:15+00:00 +lastmod: 2020-10-06T08:49:15+00:00 +draft: false +images: [] +weight: 300 +--- \ No newline at end of file diff --git a/content/en/docs/guideForClient/aboutcommunity.md b/content/en/docs/guideForClient/aboutcommunity.md new file mode 100644 index 0000000..3507513 --- /dev/null +++ b/content/en/docs/guideForClient/aboutcommunity.md @@ -0,0 +1,35 @@ +--- +title: "Community" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "guideForClient" +weight: 160 +toc: true +--- +_Community checks whether Description, Code of Conduct, Discussion, and License are enabled._ + +### Description +**What is Description?** + +This is a explanation used in Repository, which is the first item that is visible to the user, and is a concise description that best describes the topic. + +### Code of Conduct +**What is Code of Conduct?** + +A code of conduct is a document that establishes expectations for behavior for your project’s participants. + +### Discussion +**What is Discussion?** + +Collaborative communication forum for the community around an open source or internal project. + +### License +**What is License?** + +Open source licenses are licenses that comply with the Open Source Definition – in brief, they allow software to be freely used, modified, and shared. \ No newline at end of file diff --git a/content/en/docs/guideForClient/aboutsecurity.md b/content/en/docs/guideForClient/aboutsecurity.md new file mode 100644 index 0000000..75edd1a --- /dev/null +++ b/content/en/docs/guideForClient/aboutsecurity.md @@ -0,0 +1,34 @@ +--- +title: "Security" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "guideForClient" +weight: 140 +toc: true +--- +_Security checks whether Security Policy, Dependabot, CodeQL, Secret Scanning is enabled._ +### Security Policy +**What is Security Policy?** + +You can add a security policy to the repository to provide guidance on how to report security vulnerabilities in your project. + +### Dependabot +**What is Dependabot?** + +Dependabot creates Dependabot alerts when a known vulnerability is detected in the dependencies used by the project. + +### CodeQL +**What is CodeQL?** + +CodeQL can be used to identify vulnerabilities and errors in code. The result is displayed as code scanning warning in GitHub. + +### Secret Scanning +**What is Secret Scanning?** + +GitHub checks the repository for known types of secrets to prevent inadvertently committed secrets from being used for fraud. diff --git a/content/en/docs/guideForClient/abouttemplate.md b/content/en/docs/guideForClient/abouttemplate.md new file mode 100644 index 0000000..f1c9578 --- /dev/null +++ b/content/en/docs/guideForClient/abouttemplate.md @@ -0,0 +1,65 @@ +--- +title: "Template" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "guideForClient" +weight: 120 +toc: true +--- +_Template checks the presence or absence of Pull-Request Template, Issue Template, README.md, Contributing.md._ + +### Pull-Request Template +**What is Pull-Request Template?** + +Pull-Request Template (PR Template) is a template of a PR body that is entered when pr is performed. This standardizes the description format so that the code can be easily understood and looks over the parts that need to be checked during PR. + +**What Open-Set-Go has to offer?** + +Various Pull-Request Templates currently used by real open-source projects sorted by star. +- Use the template as it is. +- Use the markdown editor to modify and use the template to suit you. +- Create new ones to suit your needs with the markdown editor. + +### Issue Template +**What is Issue Template?** + +Issue templates are summarized and recorded for use in tracking issues or issues that arise during the project. + +**What Open-Set-Go has to offer?** + +Provide appropriate Issue Templates for different situations. You can write the name and description of the issue template to suit you, and you can also set the title if you want. In addition, you can add as many issue templates as you want. +- Use the template as it is. +- Create new ones to suit your needs with the markdown editor. + +### README.md +**What is README.md?** + +README.md is the first document to be viewed in the repository and describes the project. You have information about other files contained in a directory or compressed file. + +**What Open-Set-Go has to offer?** + +Various README.md currently used by real open-source projects sorted by star. Templates can be provided separately by type, such as title and description, so that users can use them in combination as they want. +- Use the template as it is. +- Use the markdown editor to modify and use the template to suit you. +- Use a combination of the types you want to modify the text. +- Create new ones to suit your needs with the markdown editor. + +### Contributing.md + +**What is Contributing.md?** + +CONTRIBUTING.md is a document that specifies information for contributors. This file can contain various information such as build requirements, development environment setting methods, and code writing guides + +**What Open-Set-Go has to offer?** + +Various Contributing.md currently used by real open-source projects sorted by star. Templates can be provided separately by type, such as title and description, so that users can use them in combination as they want. +- Use the template as it is. +- Use the markdown editor to modify and use the template to suit you. +- Use a combination of the types you want to modify the text. +- Create new ones to suit your needs with the markdown editor. \ No newline at end of file diff --git a/content/en/docs/guideForClient/tutorial.md b/content/en/docs/guideForClient/tutorial.md new file mode 100644 index 0000000..92514ee --- /dev/null +++ b/content/en/docs/guideForClient/tutorial.md @@ -0,0 +1,68 @@ +--- +title: "Tutorial" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "guideForClient" +weight: 100 +toc: true +--- +### Default Settings +**0. GitHub OAuth Sign Up/Login** + +You can check essential rights and choose organizations you want to use in Open-Set-Go. + +### Start +**1. Repository Settings** + +Set Repository Name (Validation Check), Description, the framework, .gitignore. + +**2. License Settings** + +Allows permission, condition, limitation comparison and selection of licenses provided by Github. + +**3. Pull-Request Template Settings** + +Sorting and providing various pull-request templates in githubstar order, selecting or modifying the templates to suit your needs, or creating new ones. + +**4. Issue Template Settings** + +Issue templates are provided by type, and users can select, and create the same as pull-request templates. Each Issue template can be set as title and description, and can be added as needed. + +**5. CONTRIBUTING.md Settings** + +Sorting and providing various CONTRIBUTING.md templates in githubstar order, enabling you to select or modify templates to suit your needs. Select templates categorized by type to create templates that fit your needs. + +**6. README.md Settings** + +Sorting and providing various README.md templates in githubstar order, enabling you to select or modify templates to suit your needs. Select templates categorized by type to create templates that fit your needs. + +**7. Complete Project Creation** + +When you complete the creation of the project, you send mail to which the documentations are connected. +In the repository that you created, the documents you set are committed and pushed. + +### Review +**1. Select a repository** + +When you proceed with yourself or membership/login, choose a repository that has more than push permission from the authorized organization. + +**2. Project Operational Assessment** +Divided into templates, communities, and security, the parts that have not been evaluated are marked in red circles. + +- Template checks the presence or absence of Pull-Request Template, Issue Template, README.md, Contributing.md. [More about Template](https://docs.open-set-go.com/docs/guideForClient/abouttemplate/) +- Community checks whether Description, Code of Conduct, Discussion, and License are enabled. [More about Community](https://docs.open-set-go.com/docs/guideForClient/aboutcommunity/) +- Security checks whether Security Policy, Dependabot, CodeQL, Secret Scanning is enabled. [More about Security](https://docs.open-set-go.com/docs/guideForClient/aboutsecurity/) + +**3. Project Operational Assessment** + +If you want to fill the gaps in the template part, you can select, modify, and create templates as in the start function by clicking on each Pull-Request Template, Issue Template, README.md , and Contributing.md. + +**4. Create Pull Request** + +If you make a new template through number 3, make a Pull Request. \ No newline at end of file diff --git a/content/en/docs/guideForDevelopment/_index.md b/content/en/docs/guideForDevelopment/_index.md new file mode 100644 index 0000000..4b37796 --- /dev/null +++ b/content/en/docs/guideForDevelopment/_index.md @@ -0,0 +1,10 @@ +--- +title: "Guide For Development" +description: "" +lead: "" +date: 2020-10-06T08:49:15+00:00 +lastmod: 2020-10-06T08:49:15+00:00 +draft: false +images: [] +weight: 200 +--- \ No newline at end of file diff --git a/content/en/docs/prologue/apiSpec.md b/content/en/docs/guideForDevelopment/apiSpec.md similarity index 99% rename from content/en/docs/prologue/apiSpec.md rename to content/en/docs/guideForDevelopment/apiSpec.md index b0c6c1b..9edfd17 100644 --- a/content/en/docs/prologue/apiSpec.md +++ b/content/en/docs/guideForDevelopment/apiSpec.md @@ -1,6 +1,6 @@ --- title: "API Spec" -description: "Show our Open-Set-Go Server's API specifications" +description: "Show our Open-Set-Go Server's API specifications." lead: "Show our Open-Set-Go Server's API specifications." date: 2020-10-13T15:21:01+02:00 lastmod: 2020-10-13T15:21:01+02:00 @@ -8,8 +8,8 @@ draft: false images: [] menu: docs: - parent: "prologue" -weight: 130 + parent: "guideForDevelopment" +weight: 150 toc: true --- diff --git a/content/en/docs/guideForDevelopment/commandClient.md b/content/en/docs/guideForDevelopment/commandClient.md new file mode 100644 index 0000000..a92894f --- /dev/null +++ b/content/en/docs/guideForDevelopment/commandClient.md @@ -0,0 +1,14 @@ +--- +title: "Commands For Client" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "guideForDevelopment" +weight: 190 +toc: true +--- \ No newline at end of file diff --git a/content/en/docs/prologue/commands.md b/content/en/docs/guideForDevelopment/commandServer.md similarity index 79% rename from content/en/docs/prologue/commands.md rename to content/en/docs/guideForDevelopment/commandServer.md index b786604..e3508ed 100644 --- a/content/en/docs/prologue/commands.md +++ b/content/en/docs/guideForDevelopment/commandServer.md @@ -1,15 +1,15 @@ --- -title: "Commands" -description: "Open-Set-Go comes with commands for common tasks." -lead: "Open-Set-Go comes with commands for common tasks.." +title: "Commands For Server" +description: "" +lead: "" date: 2020-10-13T15:21:01+02:00 lastmod: 2020-10-13T15:21:01+02:00 draft: false images: [] menu: docs: - parent: "prologue" -weight: 130 + parent: "guideForDevelopment" +weight: 180 toc: true --- diff --git a/content/en/docs/guideForDevelopment/contribute.md b/content/en/docs/guideForDevelopment/contribute.md new file mode 100644 index 0000000..b4f9972 --- /dev/null +++ b/content/en/docs/guideForDevelopment/contribute.md @@ -0,0 +1,163 @@ +--- +title: "Contributing" +description: "" +lead: "" +date: 2020-11-16T13:59:39+01:00 +lastmod: 2020-11-16T13:59:39+01:00 +draft: false +images: [] +menu: + docs: + parent: "guideForDevelopment" +weight: 160 +toc: true +--- +_You can also check this out on Contributing.md on our GitHub. [Shortcut of Contributing.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/CONTRIBUTING.md)_ + +# Welcome to Open-Set-Go contributing guide + +Thank you for investing your time in contributing to our Open-Set-Go project! Any contribution you make will be reflected on [Open-Set-Go.io](https://open-set-go.netlify.app/) & [README.md](https://github.com/AgainIoT/Open-Set-Go#contributors) ✨. + +We are committed to fostering a contribution-friendly environment that encourages contributions and aims to evolve into an open-source community. Please have a lot of conversations on [our Discussion](https://github.com/AgainIoT/Open-Set-Go/discussions)! + +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. +

+ +## Ways to contribute + +### Contributors + +There are several ways you can contribute to Open-Set-Go! + +- Troubleshoot problems that existed code. +- Submit Bug/Feature issues related to [bugs](https://github.com/AgainIoT/Open-Set-Go/issues?q=is%3Aopen+is%3Aissue+label%3Abug) or desired [new features](https://github.com/AgainIoT/Open-Set-Go/issues?q=is%3Aissue+is%3Aopen). +- Submit Documentation issues for insufficient documents, translations. +- Start conversation at [Discussions](https://github.com/AgainIoT/Open-Set-Go/discussions) to provide a good example of preset. +- Start conversation by posting to [Discussions](https://github.com/AgainIoT/Open-Set-Go/discussions) about a framework that needs support. +- If there's anything you'd like to communicate about our project or open source, feel free to post it on [Discussions](https://github.com/AgainIoT/Open-Set-Go/discussions)! _"We hope that **Open-Set-Go Discussions** will become an active community."_ + +### Collaborators + +If you want to contribute directly to our project, be our collaborators at Open-Set-Go! Join the [Slack](https://join.slack.com/t/open-set-go/shared_invite/zt-21jwlzs9g-qrajfUblcCtmCqAy0Xxj8w) to become a collaborator! + +- **Develop Main Features**:
+ Collaborator will develop the main features with maintainers based on milestone + All contributions are equally valuable and valuable to Open-Set-Go projects.and issues. + +- **Communication**:
+ Communicate with Open-Set-Go maintainers with [Slack](https://join.slack.com/t/open-set-go/shared_invite/zt-21jwlzs9g-qrajfUblcCtmCqAy0Xxj8w) to carry out the project. + +
+ +> All contributions are equally valuable and valuable to Open-Set-Go projects. + +
+ +## Got a Question or Problem? + +If you have any question or problem, start conversation at [Discussions](https://github.com/AgainIoT/Open-Set-Go/discussions)! +Then our maintainers, collaborators and contributers will help you. + +
+ +## Submitting a issue! + +_Do your best to follow these guidelines when submitting bug-related issues or feature requests. Then we will be able to respond quickly with good feedback more easily._ + +### Did you find a bug? + +If you find a bug in the source code, you can help us by submitting an [Bug Report issue](https://github.com/AgainIoT/Open-Set-Go/issues?q=is%3Aopen+is%3Aissue+label%3Abug). Even better, you can submit a Pull Request with a fix. +
+ +### Do you want a new feature? + +You can request a new feature by submitting an [Feature Request issue](https://github.com/AgainIoT/Open-Set-Go/issues). +_If you have a framework that needs support, please post it on Framework Request Issue!_ +
+ +### Do you want to add documentation(translation)? + +We're always looking for improvements to the documentation that make it more clear and accurate. Please let us know how the documentation can be improved such as typos and any content that is missing, unclear or inaccurate. We'll be happy to make the changes or help you make a contribution if you're interested! + +You can add documentation by create a Pull Request! +

+ +## Submission Guidelines + +You can view Submission Guidelines for each Server/Client from the link below. + +- [Client Development Settings](https://github.com/AgainIoT/Open-Set-Go_client/blob/main/CONTRIBUTING.md#submission-guidelines) +- [Server Development Settings](https://github.com/AgainIoT/Open-Set-Go_server/blob/main/CONTRIBUTING.md#submission-guidelines) +

+ +## Development Setting + +You can view Development Settings for each Server/Client from the link below. + +- [Client Development Settings](https://github.com/AgainIoT/Open-Set-Go_client/blob/main/CONTRIBUTING.md#development-setting) +- [Server Development Settings](https://github.com/AgainIoT/Open-Set-Go_server/blob/main/CONTRIBUTING.md#development-setting) +

+ +## Code of Conduct + +The maintainers who started the project are undergraduates of Kookmin University in South Korea. That's why we use English and Korean alternately. Of course, the project is based on English, but we welcome the contributions of both English and Korean. + +_For more information, see [CODE_OF_CONDUCT.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/CODE_OF_CONDUCT.md)._ +

+ +## Style Guide + +### GitLab-flow + +We are developing using GitLab-flow. See [GitLab-flow](https://about.gitlab.com/blog/2023/07/27/gitlab-flow-duo/) for more information. + +#### For Contributors + + + +#### For Collaborators + + + +### Commit Message Style + +| νƒ€μž… | λ‚΄μš© | +| -------- | ------------------------------------------------------------------------------------- | +| Init | Development Environment Initial Setting | +| Feat | Add New Features | +| Fix | Fix Bugs | +| Update | Unlike Fix, it originally operated normally, but the concept of complement | +| Remove | When deleting a file | +| Move | When moving a code or file | +| Rename | To modify a file or folder name | +| Docs | If the document is modified | +| Comment | Add and change required annotations | +| Refactor | Code refactoring (reorganizing code without changing results, increasing readability) | +| Test | Test code | +| Chore | Other minor modifications | + +``` +git config --local commit.template .gitmessage.txt +``` + +_You can apply .gitmessage.txt in the same way as above!_ + +### Commit message format + +```vi + : #<Issue Number> + +<Content> +``` + +#### Samples + +``` +Feat : New feature added! #24 + +- something added 1 +- another else added 2 +``` + + +_<center>β€» Anyone who wants to be a collaborator of Open-Set-Go is always welcome!</center>_ diff --git a/content/en/docs/guideForDevelopment/environmentVariable.md b/content/en/docs/guideForDevelopment/environmentVariable.md new file mode 100644 index 0000000..6678f4a --- /dev/null +++ b/content/en/docs/guideForDevelopment/environmentVariable.md @@ -0,0 +1,14 @@ +--- +title: "Environment Variable" +description: "" +lead: "" +date: 2020-11-16T13:59:39+01:00 +lastmod: 2020-11-16T13:59:39+01:00 +draft: false +images: [] +menu: + docs: + parent: "guideForDevelopment" +weight: 140 +toc: true +--- \ No newline at end of file diff --git a/content/en/docs/guideForDevelopment/quickStart.md b/content/en/docs/guideForDevelopment/quickStart.md new file mode 100644 index 0000000..c44ec39 --- /dev/null +++ b/content/en/docs/guideForDevelopment/quickStart.md @@ -0,0 +1,102 @@ +--- +title: "Quick Start" +description: "One page summary of how to start a Open-Set-Go project." +lead: "One page summary of how to start a Open-Set-Go project." +date: 2020-11-16T13:59:39+01:00 +lastmod: 2020-11-16T13:59:39+01:00 +draft: false +images: [] +menu: + docs: + parent: "guideForDevelopment" +weight: 120 +toc: true +--- + +### πŸ–₯️Server + +**Install with script** + +You can also easily install it through [install.sh](https://github.com/AgainIoT/Open-Set-Go#installation--development-environment)! + +**Install with docker** + +1. Pull our docker image! + + ``` + docker pull ymw0407/open-set-go_server + ``` + +2. Create `.env` file at root to use secret environment + + > See more details at [EnvironmentVariable.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/EnvironmentVariable.md) + +3. Start Open-Set-Go Server's docker with environment variable! + +**Install Manually** + +1. Clone our Repository! + + ```bash + git clone https://github.com/AgainIoT/Open-Set-Go_server.git + ``` + +2. Install the Development Environment + +3. Install Node Dependencies + ```bash + yarn install + ``` +4. Create `.env` file at root to use secret environment + + > See more details at [EnvironmentVariable.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/EnvironmentVariable.md) + +5. Start Open-Set-Go Server + + ```bash + # for development + yarn start + yarn start:dev # Restart by detecting changes in the file! + + # for production + yarn build + node dist/main.js + ``` + +### πŸ™ŽClient + +**Install with script** + +You can also easily install it through [install.sh](https://github.com/AgainIoT/Open-Set-Go#installation--development-environment)! + +**Install Manually** + +1. Clone our Repository! + + ```bash + git clone https://github.com/AgainIoT/Open-Set-Go_client.git + ``` + +2. Install the Development Environment + +3. Install Node Dependencies + ```bash + yarn install + ``` +4. Create `.env` file at root to use secret environment + + > See more details at [EnvironmentVariable.md](https://github.com/AgainIoT/Open-Set-Go/blob/main/EnvironmentVariable.md) + +5. Start Open-Set-Go Server + + ```bash + # for development + yarn start + yarn start:linux # start HTTPS for linux + yarn start:wins # start HTTPS for windows + + # for production + yarn build + yarn global add serve + serve -s build + ``` \ No newline at end of file diff --git a/content/en/docs/help/_index.md b/content/en/docs/help/_index.md index a95f18d..25ce6f2 100644 --- a/content/en/docs/help/_index.md +++ b/content/en/docs/help/_index.md @@ -1,10 +1,10 @@ --- title: "Help" -description: "Help Doks." +description: "" lead: "" date: 2020-10-06T08:49:15+00:00 lastmod: 2020-10-06T08:49:15+00:00 draft: false images: [] -weight: 900 +weight: 600 --- diff --git a/content/en/docs/help/contact.md b/content/en/docs/help/contact.md new file mode 100644 index 0000000..9275653 --- /dev/null +++ b/content/en/docs/help/contact.md @@ -0,0 +1,25 @@ +--- +title: "Contact" +description: "" +lead: "" +date: 2020-10-06T08:49:31+00:00 +lastmod: 2020-10-06T08:49:31+00:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 100 +toc: true +--- + +If you have something to ask or would like to ask the AgainIoT team for help, you can contact us in various ways below. + +- ❕ [Issue](https://github.com/AgainIoT/Open-Set-Go/issues/new/choose) + +- πŸ™ [Discussion](https://github.com/AgainIoT/Open-Set-Go/discussions/categories/q-a) + +- πŸ“§ [Mail](mailto:yunminwo1211@gmail.com) + +- πŸ’¬ [Slack](https://join.slack.com/t/open-set-go/shared_invite/zt-25xkwvzrp-mBcETQ811LK_BOEoiB8YPQ) + diff --git a/content/en/docs/help/faq.md b/content/en/docs/help/faq.md index 38bf410..3391b5f 100644 --- a/content/en/docs/help/faq.md +++ b/content/en/docs/help/faq.md @@ -9,7 +9,7 @@ images: [] menu: docs: parent: "help" -weight: 630 +weight: 160 toc: true --- {{< details "Q. How do you contribute to the Open-Set-Go project?" >}} diff --git a/content/en/docs/help/reference.md b/content/en/docs/help/reference.md deleted file mode 100644 index 811d51c..0000000 --- a/content/en/docs/help/reference.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "Reference documents" -description: "One page that summarizes the recommendation tool introduction, usage, etc" -lead: "One page that summarizes the recommendation tool introduction, usage, etc" -date: 2023-09-04T01:04:30+09:00 -lastmod: 2023-09-04T01:04:30+09:00 -draft: false -images: [] -menu: - docs: - parent: "" - identifier: "reference-ad9989823afe2b0c97c9ff1a8ae1de8b" -weight: 999 -toc: true ---- - -### Community - -Slack is an app used for collaboration. You can communicate with your team, as well as create and use channels as a community or for various purposes. -{{< alert icon="πŸ‘‰" >}} If you're new to Slack or if it's still difficult? [Getting started for Slack admins](https://slack.com/intl/en-gb/help/categories/360000049043) {{< /alert >}} - -In addition, you can connect Slack and GitHub, so you can receive notifications such as GitHub Puliquet and Issue. -{{< alert icon="πŸ‘‰" >}} If you want to connect Slack and GitHub? [How to connect Slack to GitHub](https://slack.github.com/) {{< /alert >}} - -### Tool - -Sonar Cloud is a tool that easily integrates into the cloud DevOps platform and uses code review tools that extend CI/CD workflows when teams want to deliver clean code consistently and efficiently. -{{< alert icon="πŸ‘‰" >}} -What is SonarCloud? [Sonarcloud Document](https://docs.sonarcloud.io/) πŸ‘‰ How to use SonarCloud? [Sonarcloud?](https://www.sonarsource.com/products/sonarcloud/?gads_campaign=SC-Hroi-Brand&gads_ad_group=SonarCloud&gads_keyword=sonarcloud&gclid=CjwKCAjw3dCnBhBCEiwAVvLcuw2gx3ghQq_AFOWEksB18wXgY-66606OoWOKfSpEnAmJ-RbUW-FAxRoC8P8QAvD_BwE) -{{< /alert >}} - -### VScode extension - -VS Code extensions let you add languages, debuggers, and tools to your installation to support your development workflow. - -{{< alert icon="πŸ‘‰" >}} -Prettier is an opinionated code formatter that applies a consistent code style to the entire codebase because it ignores the original style.<br>[Learn more about Prettier](https://prettier.io/) -{{< /alert >}} - -{{< alert icon="πŸ‘‰" >}} -ESLint statically analyzes your code to quickly find problems. It is built into most text editors and you can run ESLint as part of your continuous integration pipeline.<br>[Learn more about ESLint](https://eslint.org/) -{{< /alert >}} - -{{< alert icon="πŸ‘‰" >}} -Auto Rename Tag automatically renames the paired HTML/XML tags when you rename one HTML/XML tag.<br>[Learn more about Auto Rename Tag](https://github.com/formulahendry/vscode-auto-rename-tag) -{{< /alert >}} diff --git a/content/en/docs/help/templateRequest.md b/content/en/docs/help/templateRequest.md new file mode 100644 index 0000000..fe71414 --- /dev/null +++ b/content/en/docs/help/templateRequest.md @@ -0,0 +1,23 @@ +--- +title: "Template Request" +description: "" +lead: "" +date: 2020-10-06T08:49:31+00:00 +lastmod: 2020-10-06T08:49:31+00:00 +draft: false +images: [] +menu: + docs: + parent: "help" +weight: 120 +toc: true +--- +[Go to Create Template Request ➑️](https://github.com/AgainIoT/Open-Set-Go/issues/new?assignees=&labels=template-request&projects=&template=Templates.yml&title=%F0%9F%93%83+%5BTEMPLATE+REQUEST%5D+-+%3Ctitle%3E) + +### When do I use this? +A template that requests Open-Set-Go to enter a template. You can use it if you have a template you want to use or if you want to recommend it to others. + +### What should you write? +Enter the type of template you want (Readme.md , Issue Template, etc.), Owner/Repository, GitHub Stars, License, Content. + +⚠️ Note that there are only three licenses available: Apache License 2.0, MIT, and BSD-3-Clause. \ No newline at end of file diff --git a/content/en/docs/license/OpenSetGo.md b/content/en/docs/license/OpenSetGo.md new file mode 100644 index 0000000..99b850d --- /dev/null +++ b/content/en/docs/license/OpenSetGo.md @@ -0,0 +1,14 @@ +--- +title: "Open-Set-Go" +description: "License of Open-Set-Go." +lead: "License of Open-Set-Go." +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "license" +weight: 120 +toc: true +--- \ No newline at end of file diff --git a/content/en/docs/license/OpenSetGoClient.md b/content/en/docs/license/OpenSetGoClient.md new file mode 100644 index 0000000..325495f --- /dev/null +++ b/content/en/docs/license/OpenSetGoClient.md @@ -0,0 +1,14 @@ +--- +title: "Open-Set-Go_client" +description: "License of Open-Set-Go_client." +lead: "License of Open-Set-Go_client." +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "license" +weight: 140 +toc: true +--- \ No newline at end of file diff --git a/content/en/docs/license/OpenSetGoServer.md b/content/en/docs/license/OpenSetGoServer.md new file mode 100644 index 0000000..0a5ce2c --- /dev/null +++ b/content/en/docs/license/OpenSetGoServer.md @@ -0,0 +1,14 @@ +--- +title: "Open-Set-Go_server" +description: "License of Open-Set-Go_server." +lead: "License of Open-Set-Go_server." +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "license" +weight: 160 +toc: true +--- \ No newline at end of file diff --git a/content/en/docs/license/OpenSetGoio.md b/content/en/docs/license/OpenSetGoio.md new file mode 100644 index 0000000..dfa0dc0 --- /dev/null +++ b/content/en/docs/license/OpenSetGoio.md @@ -0,0 +1,14 @@ +--- +title: "Open-Set-Go.io" +description: "License of Open-Set-Go.io." +lead: "License of Open-Set-Go.io." +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "license" +weight: 180 +toc: true +--- \ No newline at end of file diff --git a/content/en/docs/license/_index.md b/content/en/docs/license/_index.md index 4bece5f..0bf145c 100644 --- a/content/en/docs/license/_index.md +++ b/content/en/docs/license/_index.md @@ -6,7 +6,7 @@ date: 2020-10-06T08:49:15+00:00 lastmod: 2020-10-06T08:49:15+00:00 draft: false images: [] -weight: 600 +weight: 500 --- diff --git a/content/en/docs/license/license.md b/content/en/docs/license/license.md index d5a4912..b78abd1 100644 --- a/content/en/docs/license/license.md +++ b/content/en/docs/license/license.md @@ -10,7 +10,7 @@ menu: docs: parent: "license" identifier: "license-5677179c5ded817788cab2ea8820717c" -weight: 999 +weight: 100 toc: true --- diff --git a/content/en/docs/lorem/_index.md b/content/en/docs/lorem/_index.md deleted file mode 100644 index 86fcd8f..0000000 --- a/content/en/docs/lorem/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Lorem" -description: "" -lead: "" -date: 2022-01-18T19:58:14+01:00 -lastmod: 2022-01-18T19:58:14+01:00 -draft: true -images: [] -toc: true ---- diff --git a/content/en/docs/lorem/ipsum/_index.md b/content/en/docs/lorem/ipsum/_index.md deleted file mode 100644 index e575fc5..0000000 --- a/content/en/docs/lorem/ipsum/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Ipsum" -description: "" -lead: "" -date: 2022-01-18T20:00:32+01:00 -lastmod: 2022-01-18T20:00:32+01:00 -draft: false -images: [] -menu: - docs: - parent: "lorem" - identifier: "ipsum" -weight: 999 -toc: true ---- diff --git a/content/en/docs/lorem/ipsum/amet/_index.md b/content/en/docs/lorem/ipsum/amet/_index.md deleted file mode 100644 index dbbeabd..0000000 --- a/content/en/docs/lorem/ipsum/amet/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Amet" -description: "" -lead: "" -date: 2022-01-18T20:07:56+01:00 -lastmod: 2022-01-18T20:07:56+01:00 -draft: false -images: [] -menu: - docs: - parent: "ipsum" - identifier: "amet" -weight: 999 -toc: true ---- diff --git a/content/en/docs/lorem/ipsum/amet/consectetur/index.md b/content/en/docs/lorem/ipsum/amet/consectetur/index.md deleted file mode 100644 index 23771e3..0000000 --- a/content/en/docs/lorem/ipsum/amet/consectetur/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Consectetur" -description: "" -lead: "" -date: 2022-01-18T20:17:32+01:00 -lastmod: 2022-01-18T20:17:32+01:00 -draft: false -images: [] -menu: - docs: - parent: "amet" -weight: 730 -toc: true ---- diff --git a/content/en/docs/lorem/ipsum/dolor/index.md b/content/en/docs/lorem/ipsum/dolor/index.md deleted file mode 100644 index a744e72..0000000 --- a/content/en/docs/lorem/ipsum/dolor/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Dolor" -description: "" -lead: "" -date: 2022-01-18T20:01:45+01:00 -lastmod: 2022-01-18T20:01:45+01:00 -draft: false -images: [] -menu: - docs: - parent: "ipsum" -weight: 700 -toc: true ---- diff --git a/content/en/docs/lorem/ipsum/sit/index.md b/content/en/docs/lorem/ipsum/sit/index.md deleted file mode 100644 index e4c84e4..0000000 --- a/content/en/docs/lorem/ipsum/sit/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Sit" -description: "" -lead: "" -date: 2022-01-18T20:05:19+01:00 -lastmod: 2022-01-18T20:05:19+01:00 -draft: false -images: [] -menu: - docs: - parent: "ipsum" -weight: 710 -toc: true ---- diff --git a/content/en/docs/prologue/_index.md b/content/en/docs/prologue/_index.md index d6b467c..e0d7a47 100644 --- a/content/en/docs/prologue/_index.md +++ b/content/en/docs/prologue/_index.md @@ -1,6 +1,6 @@ --- title : "Prologue" -description: "Prologue Doks." +description: "" lead: "" date: 2020-10-06T08:48:45+00:00 lastmod: 2020-10-06T08:48:45+00:00 diff --git a/content/en/docs/prologue/introduction.md b/content/en/docs/prologue/introduction.md index 9775e05..c606f5b 100644 --- a/content/en/docs/prologue/introduction.md +++ b/content/en/docs/prologue/introduction.md @@ -1,7 +1,7 @@ --- title: "Introduction" -description: "Open-Set-Go is a starting toolkit that allows anyone to start and operate open-source projects easily and quickly." -lead: "Open-Set-Go is a starting toolkit that allows anyone to start and operate open-source projects easily and quickly." +description: "What the pages in Docs contain." +lead: "What the pages in Docs contain." date: 2020-10-06T08:48:57+00:00 lastmod: 2023-08-30T17:07:19+00:00 draft: false @@ -12,37 +12,44 @@ menu: weight: 100 toc: true --- +### 🚩 Prologue -### πŸš€Quick Start +--- + +This page contains a one-line introduction to Open-Set-Go, a description, and the features it provides. It consists of Introduction, What is Open-Set-Go?, Why Open-Set-Go?. [Prologue β†’](https://docs.open-set-go.com/docs/prologue/whatIsOpenSetGo/) +<br></br> + + +### 🀝 Guide For Development --- -One page summary of how to start a new Open-Set-Go project. [Quick Start β†’](https://docs.open-set-go.com/docs/prologue/quick-start/) +This page is intended for developers who want to contribute to the development of the Open-Set-Go project. It consists of Quick Start, Environment Variable, API Spec, Contribution, and Commands. [Guide For Development β†’](https://docs.open-set-go.com/docs/guideForDevelopment/quickStart/) <br></br> -### πŸ“ŒCommands +### πŸ“Œ Guide For Client --- -One page summarizing commands for common tasks in Open-Set-Go. [Commands β†’](https://docs.open-set-go.com/docs/prologue/commands/) +This page is for those who want to use Open-Set-Go to create new open-source projects or review operations for existing projects. It consists of Tutorial, Template, Security, Security, and Recommandation. [Guide For Client β†’](https://docs.open-set-go.com/docs/guideForClient/tutorial/) <br></br> -### πŸ”ŽTemplate Guides +### πŸ”Ž Template Guides --- -Learn how to customize Doks to fully make it your own. [Template Guides β†’](https://docs.open-set-go.com/docs/templates/express/) +This page describes the languages, versions, and more that need to be installed according to the framework. Now it's about Express, NestJS, React. [Template Guides β†’](https://docs.open-set-go.com/docs/templates/express/) <br></br> -### πŸ‘©β€πŸ‘©β€πŸ‘§β€πŸ‘¦Contributing +### πŸ”’ License --- -Find out how to contribute to Doks. [Contributing β†’](http://github.com/AgainIoT/Open-Set-Go/blob/main/CONTRIBUTING.md) +Each repository in Open-Set-Go has been licensed and verified for third-party license dependencies. Each page contains information about four repositories, Open-Set-Go, Open-Set-Go_server, Open-Set-Go_client, and Open-Set-Go.io. [License β†’](https://docs.open-set-go.com/docs/license/license/) <br></br> -### πŸ’‘Help +### πŸ’‘ Help --- -Get help on Doks. [Help β†’](https://docs.open-set-go.com/docs/help/faq/) +This is a page that you can check when you have questions or want to ask for help from the again IoT team. You can ask questions directly by the way you are in contact, check the FAQs to see the answers to your questions, and request the template you want through the Template Request. [Help β†’](https://docs.open-set-go.com/docs/help/contact/) diff --git a/content/en/docs/prologue/quick-start.md b/content/en/docs/prologue/quick-start.md deleted file mode 100644 index 1433692..0000000 --- a/content/en/docs/prologue/quick-start.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "Quick Start" -description: "One page summary of how to start a Open-Set-Go project." -lead: "One page summary of how to start a Open-Set-Go project." -date: 2020-11-16T13:59:39+01:00 -lastmod: 2020-11-16T13:59:39+01:00 -draft: false -images: [] -menu: - docs: - parent: "prologue" -weight: 110 -toc: true ---- - -### πŸ–₯️Server - -**<li> Clone our Repository** - -```bash -git clone --recursive https://github.com/AgainIoT/Open-Set-Go_server.git - -###################################### -# Open-Set-Go Repository Dependencies -# -# Open-Set-Go_server -# β”— environment-template -# -###################################### -``` - -**<li> Install the Development Environment** - -**<li> Install Node Dependencies** - -```bash -yarn install -``` - -**<li> Create your own github-oauth app** - -Follow the [GitHub Docs](https://docs.github.com/ko/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) to get Client ID & Client Secret.<br> -If your Authorization URL should be `localhost:3000` ! - -**<li> Create `.env` file at root to use secret environment** - -```bash -touch .env -``` - -**<li> Fill in the `.env` file as follows** - -```bash -MONGODB_URI="<Your-MongoDB-URI-start-with-mongodb://>" -CLIENT_ID="<Your-GitHub-OAuth-Client_ID>" -CLIENT_SECRET="<Your-GitHub-OAuth-Client_Secret>" -JWT_SECRET="<Any-JWT-Secret-You-Want>" -JWT_EXPIRATION_TIME="<JWT-Expiration-Time-You-Want-default-18000>" -``` - -**<li> Start Open-Set-Go Server** - -```bash - yarn start -``` - -### πŸ™ŽClient - -**<li> Clone our Repository** - -```bash -git clone https://github.com/AgainIoT/Open-Set-Go_client.git - -###################################### -# Open-Set-Go Repository Dependencies -# -# Open-Set-Go_client -# -###################################### -``` - -**<li> Install the Development Environment** - -**<li> Install Node Dependencies** - -```bash - yarn install -``` - -**<li> Create your own github-oauth app** - -Follow the [GitHub Docs](https://docs.github.com/ko/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) to get Client ID & Client Secret.<br> -If your Authorization URL should be `localhost:3000` ! - -**<li> Create `.env` file at root to use secret environment** - -```bash -touch .env -``` - -**<li> Fill in the `.env` file as follows** - -```bash -REACT_APP_CLIENT_ID="<Your-GitHub-OAuth-Client_ID>" -REACT_APP_REDIRECT_URL="http://localhost:3000/login" -REACT_APP_SERVER_URL="http://localhost:8080" -``` - -**<li> Start Open-Set-Go Server** - -```bash -yarn start -``` diff --git a/content/en/docs/prologue/whatIsOpenSetGo.md b/content/en/docs/prologue/whatIsOpenSetGo.md new file mode 100644 index 0000000..e733171 --- /dev/null +++ b/content/en/docs/prologue/whatIsOpenSetGo.md @@ -0,0 +1,14 @@ +--- +title: "What is Open-Set-Go?" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 130 +toc: true +--- \ No newline at end of file diff --git a/content/en/docs/prologue/whatisopensetgo.md b/content/en/docs/prologue/whatisopensetgo.md new file mode 100644 index 0000000..e120684 --- /dev/null +++ b/content/en/docs/prologue/whatisopensetgo.md @@ -0,0 +1,27 @@ +--- +title: "What is Open-Set-Go?" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 130 +toc: true +--- +### Summary +--- +**Open-Set-Go** is the `Open-Source Management Platform` for Open-Source Developers. Open-Set-Go provides the creation of new open-source projects and operational review for existing projects. + +### Description +--- +**Open-Set-Go** is dependent on **GitHub**, and the GitHub OAuth 2.0 authorization process allows you analyze, create, and requests Pull-Request from your(or your organization's) GitHub repository. + +- Create [Pull-Request Template](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request), [Issue Templates](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue), [README.md](https://docs.github.com/ko/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes), [CONTRIBUTING.md](https://mozillascience.github.io/working-open-workshop/contributing/) with Open-Set-Go! + +- Open-Set-Go provides documents from many well-known open-source projects and allows them to be modified with markdown editor! + +- Create beautiful documents easily and simply using Open-Set-Go's personalized template! \ No newline at end of file diff --git a/content/en/docs/prologue/whyOpenSetGo.md b/content/en/docs/prologue/whyOpenSetGo.md new file mode 100644 index 0000000..92037cc --- /dev/null +++ b/content/en/docs/prologue/whyOpenSetGo.md @@ -0,0 +1,14 @@ +--- +title: "Why Open-Set-Go?" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 160 +toc: true +--- \ No newline at end of file diff --git a/content/en/docs/prologue/whyopensetgo.md b/content/en/docs/prologue/whyopensetgo.md new file mode 100644 index 0000000..0e35cd6 --- /dev/null +++ b/content/en/docs/prologue/whyopensetgo.md @@ -0,0 +1,28 @@ +--- +title: "Why Open-Set-Go?" +description: "" +lead: "" +date: 2020-10-13T15:21:01+02:00 +lastmod: 2020-10-13T15:21:01+02:00 +draft: false +images: [] +menu: + docs: + parent: "prologue" +weight: 160 +toc: true +--- +### For starting new Open-Source Project + +It is not just to create a Source-Open Project, but to create a contribution-friendly environment and create an environment where communication between developers and contributors is smooth to create sustainable open source projects. +In addition, **Open-Set-Go** makes it easy, fast, and simple to build a contribution-friendly environment at the start of an open-source project. + +### For continuing the open-source project + +It provides an open-source operation review feature for three areas for the open-source project in progress. + +- Template: Ensure that there are templates required to sustain open source. Using the features of Open-Set-Go, additional templates can be created to make pull-request requests. + +- Security: Check whether the features provided by GitHub for the security of open-source projects are activated. + +- Community: Check the elements needed to build an open-source community. \ No newline at end of file diff --git a/content/en/docs/templates/_index.md b/content/en/docs/templates/_index.md index fcb5529..4e4ddef 100644 --- a/content/en/docs/templates/_index.md +++ b/content/en/docs/templates/_index.md @@ -6,5 +6,5 @@ date: 2020-10-06T08:48:45+00:00 lastmod: 2023-09-01T13:59:54+00:00 draft: false images: [] -weight: 100 +weight: 400 --- diff --git a/content/en/privacy-policy/index.md b/content/en/privacy-policy/index.md deleted file mode 100644 index 6315024..0000000 --- a/content/en/privacy-policy/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "Privacy Policy" -description: "We do not use cookies and we do not collect any personal data." -date: 2020-08-27T19:23:18+02:00 -lastmod: 2020-08-27T19:23:18+02:00 -draft: true -images: [] ---- - -__TLDR__: We do not use cookies and we do not collect any personal data. - -## Website visitors - -- No personal information is collected. -- No information is stored in the browser. -- No information is shared with, sent to or sold to third-parties. -- No information is shared with advertising companies. -- No information is mined and harvested for personal and behavioral trends. -- No information is monetized. - -### Information we collect and what we use it for - -We run [Plausible](https://plausible.io/) analytics on getdoks.org. The following information is collected: - -- __Page URL__. We track the page URL of each page view on this website. We use this to understand which pages have been viewed and how many times a particular page has been viewed. For example: _https://getdoks.org/_. -- __HTTP Referrer__. We use the referrer string to understand the number of visitors referred to this website from links on other sites. For example: _https://github.com/_. -- __Browser__. We use this to understand what browsers people use when visiting this website. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _Chrome_. -- __Operating system__. We use this to understand what operating systems people use when visiting this website. We only use the brand of the operating system and don’t include the version number or any other details. This is derived from the User-Agent HTTP header. The full User-Agent is discarded. For example: _GNU/Linux_. -- __Device type__. We use this to understand what devices people use when visiting this website. This is derived from window.innerWidth. The actual width of the browser in pixels is discarded. For example: _Desktop_. -- __Visitor Country__. We look up the visitor’s country using the IP address. We do not track anything more granular than the country of origin and the IP address of the visitor is discarded. We never store IP addresses in our database or logs. For example: _Canada_. - -## Contact us - -[Contact us]({{< relref "contact/index.md" >}}) if you have any questions. - -Effective Date: _27th August 2020_