Merge pull request #31 from AgainIoT/againIoT

Update information as you add information and update your version
AgainIoT · Nov 7, 2023 · 2f0ca22 · 2f0ca22
2 parents 41c2766 + fa9bf70
commit 2f0ca22
Show file tree

Hide file tree

Showing 15 changed files with 64 additions and 18 deletions.
diff --git a/content/en/docs/guideForClient/aboutcommunity.md b/content/en/docs/guideForClient/aboutcommunity.md
@@ -21,20 +21,28 @@ _Community checks whether Description, Code of Conduct, Discussion, and License
 
 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.
 
+[More about Description](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository)
+
 ### 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.
 
+[More about Code of Conduct](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
+
 ### Discussion
 
 **What is Discussion?**
 
 Collaborative communication forum for the community around an open source or internal project.
 
+[More about Discussion](https://docs.github.com/en/discussions/quickstart)
+
 ### 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.
+
+[More about License](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)
diff --git a/content/en/docs/guideForClient/aboutsecurity.md b/content/en/docs/guideForClient/aboutsecurity.md
@@ -21,20 +21,28 @@ _Security checks whether Security Policy, Dependabot, CodeQL, Secret Scanning is
 
 You can add a security policy to the repository to provide guidance on how to report security vulnerabilities in your project.
 
+[More about Security Policy](https://docs.github.com/en/enterprise-server@3.6/code-security/getting-started/adding-a-security-policy-to-your-repository)
+
 ### Dependabot
 
 **What is Dependabot?**
 
 Dependabot creates Dependabot alerts when a known vulnerability is detected in the dependencies used by the project.
 
+[More about Dependabot](https://docs.github.com/en/code-security/dependabot/dependabot-alerts)
+
 ### 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.
 
+[More about CodeQL](https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql)
+
 ### 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.
+
+[More about Secret Scanning](https://docs.github.com/en/code-security/secret-scanning/about-secret-scanning)
diff --git a/content/en/docs/guideForClient/abouttemplate.md b/content/en/docs/guideForClient/abouttemplate.md
@@ -13,14 +13,16 @@ weight: 120
 toc: true
 ---
 
-_Template checks the presence or absence of Pull-Request Template, Issue Template, README.md, Contributing.md._
+_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.
 
+[More about Pull-Request Template](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
+
 **What Open-Set-Go has to offer?**
 
 Various Pull-Request Templates currently used by real open-source projects sorted by star.
@@ -35,6 +37,8 @@ Various Pull-Request Templates currently used by real open-source projects sorte
 
 Issue templates are summarized and recorded for use in tracking issues or issues that arise during the project.
 
+[More about Issue Template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
+
 **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.
@@ -48,6 +52,8 @@ Provide appropriate Issue Templates for different situations. You can write the
 
 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.
 
+[More about README.md](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)
+
 **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.
@@ -57,15 +63,17 @@ Various README.md currently used by real open-source projects sorted by star. Te
 - 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
+### CONTRIBUTING.md
+
+**What is 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.
 
-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
+[More about CONTRIBUTING.md](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)
 
 **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.
+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.

diff --git a/content/en/docs/guideForClient/tutorial.md b/content/en/docs/guideForClient/tutorial.md
@@ -59,13 +59,13 @@ When you proceed with yourself or membership/login, choose a repository that has
 
 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/)
+- 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.
+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**
 

diff --git a/content/en/docs/guideForDevelopment/contribute.md b/content/en/docs/guideForDevelopment/contribute.md
@@ -13,7 +13,7 @@ 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)_
+_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
 
@@ -112,14 +112,6 @@ _For more information, see [CODE_OF_CONDUCT.md](https://github.com/AgainIoT/Open
 
 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
-
-<img src="https://github.com/AgainIoT/Open-Set-Go/blob/main/.github/images/contributors_branching.jpg?raw=true"/>
-
-#### For Collaborators
-
-<img src="https://github.com/AgainIoT/Open-Set-Go/blob/main/.github/images/collaborators_branching.jpg?raw=true"/>
-
 ### Commit Message Style
 
 | 타입 | 내용 |

diff --git a/content/en/docs/help/faq.md b/content/en/docs/help/faq.md
@@ -13,5 +13,5 @@ weight: 160
 toc: true
 ---
 {{< details "Q. How do you contribute to the Open-Set-Go project?" >}}
-To learn how to contribute, visit contributing.md. [Shortcut to contributing.md](http://github.com/AgainIoT/Open-Set-Go/blob/main/CONTRIBUTING.md)
+To learn how to contribute, visit CONTRIBUTING.md. [Shortcut to CONTRIBUTING.md](http://github.com/AgainIoT/Open-Set-Go/blob/main/CONTRIBUTING.md)
 {{< /details >}}
diff --git a/content/en/showcase/open-set-go/checked.png b/content/en/showcase/open-set-go/checked.png
diff --git a/content/en/showcase/open-set-go/index.md b/content/en/showcase/open-set-go/index.md
@@ -16,10 +16,12 @@ homepage: false
 
 ## Introduction
 
-'Project Starting Toolkit' for open SW developers who can easily and easily start an Open Source project
+'The Open-Source Management Platform' for Open-Source Developers that provides the creation of new open-source projects and operational review for existing projects.
 
 ## Functionalities
 
+### 1. Create Repository
+
 <img src="repo.png" width="28"> **Repository**
 
 Create repository and create .gitignore file with language, framework, and os information.
@@ -44,6 +46,34 @@ Users can select from multiple presets what they want to write in their projects
 
 Select and insert a preset for each content, and you can write the details according to your project by referring to the preset.
 
+### 2. Review
+
+<img src="review.png">
+
+There is a review function to evaluate whether an already created repository is suitable for an open-source project. Evaluate the 12 capabilities provided by the hub to build an open-source project environment in three categories. This evaluation of operations understands and enables these 12 factors to effectively run open-source projects.
+
+**Summary** <img src="summary.png">
+
+The Summary provides a brief summary of the results of the operational evaluation. You can select only the items you want and check them with a graph, or you can check the quantity of each item.
+
+<img src="none.png">
+
+Does not exist or is not active
+
+<img src="checked.png">
+
+Exists and Active
+
+<img src="need authority.png">
+
+Owner or more privileges required
+
+**Notification** <img src="noti.png">
+Notification provides a description of 'need authority' and 'None'. Provides a brief description of when an item does not have access or fails.
+
+**Add Template** <img src="review_pr.png">
+When the user modifies the template and clicks the Complete button, a pull-request is created for the selected repository. You can add an Issue Template, Pull-Request Template, README.md , and Contributing.md the same as you did with the Create Repository.
+
 ## Website
 
 [<li> GitHub](https://github.com/AgainIoT/Open-Set-Go)

diff --git a/content/en/showcase/open-set-go/main.png b/content/en/showcase/open-set-go/main.png
diff --git a/content/en/showcase/open-set-go/need authority.png b/content/en/showcase/open-set-go/need authority.png
diff --git a/content/en/showcase/open-set-go/none.png b/content/en/showcase/open-set-go/none.png
diff --git a/content/en/showcase/open-set-go/noti.png b/content/en/showcase/open-set-go/noti.png
diff --git a/content/en/showcase/open-set-go/review.png b/content/en/showcase/open-set-go/review.png
diff --git a/content/en/showcase/open-set-go/review_pr.png b/content/en/showcase/open-set-go/review_pr.png
diff --git a/content/en/showcase/open-set-go/summary.png b/content/en/showcase/open-set-go/summary.png