Merge pull request #29 from AgainIoT/againIoT

Again io t

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

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
+---

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 >}}

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 <br>
+✅ Manage 5 Projects <br>
+✅ Vulnerability Management <br>
+✅ 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 >}}

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
+---

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.

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.

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.

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.

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
+---

content/en/docs/prologue/apiSpec.md → content/en/docs/guideForDevelopment/apiSpec.md

@@ -1,15 +1,15 @@
 ---
 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
 draft: false
 images: []
 menu:
  docs:
- parent: "prologue"
-weight: 130
+ parent: "guideForDevelopment"
+weight: 150
 toc: true
 ---
 

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
+---

content/en/docs/prologue/commands.md → 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
 ---