Skip to content

Commit 76c838f

Browse files
authored
Merge pull request #30 from AgainIoT/againIoT
Again io t
2 parents a172c73 + c169ce1 commit 76c838f

File tree

17 files changed

+1089
-275
lines changed

17 files changed

+1089
-275
lines changed

content/en/docs/guideForClient/Recommandation/community.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,28 @@ menu:
1212
weight: 100
1313
toc: true
1414
---
15+
1516
### Slack
17+
1618
- Slack is an enterprise messaging app that connects people and information.
1719
- Slack can improve how organizations communicate by bringing people together and running a unified team.
1820
- You can communicate with your team, as well as create and use channels as a community or for various purposes.
19-
{{< 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 >}}
21+
{{< 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 >}}
2022

2123
### Connect Slack and GitHub
24+
2225
- In addition, you can connect Slack and GitHub, so you can receive notifications such as GitHub Puliquet and Issue.
23-
{{< alert icon="👉" >}} If you want to connect Slack and GitHub? [How to connect Slack to GitHub](https://slack.github.com/) {{< /alert >}}
26+
{{< alert icon="👉" >}} If you want to connect Slack and GitHub? [How to connect Slack to GitHub](https://slack.github.com/) {{< /alert >}}
2427

2528
### Discord
29+
2630
- Discord is a place where you can feel a bond by belonging to the community and more easily, hang out and talk every day.
2731
- Discord servers are divided into topic-based channels, so you can cooperate, share, and talk comfortably in a group room without congestion.
2832
- You are given administrative tools that can be run by any community, and you can also specify the members' permissions.
29-
{{< 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 >}}
33+
{{< 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 >}}
3034

3135
### GitHub Discussion
36+
3237
- GitHub Discussions is a joint communication forum for the community around open source or internal projects.
3338
- Community members can ask questions, answer questions, share updates, have open conversations, and follow decisions that affect how the community works.
34-
{{< 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 >}}
39+
{{< 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

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,20 @@ menu:
1212
weight: 120
1313
toc: true
1414
---
15+
1516
### Sonar Cloud
17+
1618
- 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.
17-
{{< alert icon="👉" >}} What is SonarCloud? [Sonarcloud Document](https://docs.sonarcloud.io/) {{< /alert >}}
18-
{{< 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 >}}
19+
{{< alert icon="👉" >}} What is SonarCloud? [Sonarcloud Document](https://docs.sonarcloud.io/) {{< /alert >}}
20+
{{< 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 >}}
1921

2022
### GitHub Actions
23+
2124
- 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.
22-
{{< alert icon="👉" >}} How to use GitHub Actions? [Quickstart for GitHub Actions](https://docs.github.com/en/actions/quickstart) {{< /alert >}}
25+
{{< alert icon="👉" >}} How to use GitHub Actions? [Quickstart for GitHub Actions](https://docs.github.com/en/actions/quickstart) {{< /alert >}}
2326

2427
### FOSSA
28+
2529
- FOSSA protects code by mitigating open source risk.
2630
- Software protection against open source risk management and license violations, vulnerabilities, and supply chain threats.
2731

@@ -32,5 +36,6 @@ toc: true
3236
{{< alert icon="👉" >}} How to use FOSSA? [Quickstart for FOSSA](https://docs.fossa.com/docs/getting-started) {{< /alert >}}
3337

3438
### Dependabot
39+
3540
- Dependabot creates Dependabot alerts when a known vulnerability is detected in the dependencies used by the project.
36-
{{< 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 >}}
41+
{{< 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/aboutcommunity.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,29 @@ menu:
1212
weight: 160
1313
toc: true
1414
---
15+
1516
_Community checks whether Description, Code of Conduct, Discussion, and License are enabled._
1617

1718
### Description
19+
1820
**What is Description?**
1921

2022
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.
2123

2224
### Code of Conduct
25+
2326
**What is Code of Conduct?**
2427

2528
A code of conduct is a document that establishes expectations for behavior for your project’s participants.
2629

2730
### Discussion
31+
2832
**What is Discussion?**
2933

3034
Collaborative communication forum for the community around an open source or internal project.
3135

3236
### License
37+
3338
**What is License?**
3439

35-
Open source licenses are licenses that comply with the Open Source Definition – in brief, they allow software to be freely used, modified, and shared.
40+
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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,29 @@ menu:
1212
weight: 140
1313
toc: true
1414
---
15+
1516
_Security checks whether Security Policy, Dependabot, CodeQL, Secret Scanning is enabled._
17+
1618
### Security Policy
19+
1720
**What is Security Policy?**
1821

1922
You can add a security policy to the repository to provide guidance on how to report security vulnerabilities in your project.
2023

2124
### Dependabot
25+
2226
**What is Dependabot?**
2327

2428
Dependabot creates Dependabot alerts when a known vulnerability is detected in the dependencies used by the project.
2529

2630
### CodeQL
31+
2732
**What is CodeQL?**
2833

2934
CodeQL can be used to identify vulnerabilities and errors in code. The result is displayed as code scanning warning in GitHub.
3035

3136
### Secret Scanning
37+
3238
**What is Secret Scanning?**
3339

3440
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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,46 @@ menu:
1212
weight: 120
1313
toc: true
1414
---
15+
1516
_Template checks the presence or absence of Pull-Request Template, Issue Template, README.md, Contributing.md._
1617

1718
### Pull-Request Template
19+
1820
**What is Pull-Request Template?**
1921

2022
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.
2123

2224
**What Open-Set-Go has to offer?**
2325

2426
Various Pull-Request Templates currently used by real open-source projects sorted by star.
27+
2528
- Use the template as it is.
2629
- Use the markdown editor to modify and use the template to suit you.
2730
- Create new ones to suit your needs with the markdown editor.
2831

2932
### Issue Template
33+
3034
**What is Issue Template?**
3135

3236
Issue templates are summarized and recorded for use in tracking issues or issues that arise during the project.
3337

3438
**What Open-Set-Go has to offer?**
3539

3640
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.
41+
3742
- Use the template as it is.
3843
- Create new ones to suit your needs with the markdown editor.
3944

4045
### README.md
46+
4147
**What is README.md?**
4248

4349
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.
4450

4551
**What Open-Set-Go has to offer?**
4652

4753
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.
54+
4855
- Use the template as it is.
4956
- Use the markdown editor to modify and use the template to suit you.
5057
- Use a combination of the types you want to modify the text.
@@ -59,7 +66,8 @@ CONTRIBUTING.md is a document that specifies information for contributors. This
5966
**What Open-Set-Go has to offer?**
6067

6168
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.
69+
6270
- Use the template as it is.
6371
- Use the markdown editor to modify and use the template to suit you.
6472
- Use a combination of the types you want to modify the text.
65-
- Create new ones to suit your needs with the markdown editor.
73+
- Create new ones to suit your needs with the markdown editor.

content/en/docs/guideForClient/tutorial.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,57 +12,61 @@ menu:
1212
weight: 100
1313
toc: true
1414
---
15+
1516
### Default Settings
16-
**0. GitHub OAuth Sign Up/Login**
17+
18+
GitHub OAuth Sign Up/Login
1719

1820
You can check essential rights and choose organizations you want to use in Open-Set-Go.
1921

2022
### Start
21-
**1. Repository Settings**
23+
24+
1.**Repository Settings**
2225

2326
Set Repository Name (Validation Check), Description, the framework, .gitignore.
2427

25-
**2. License Settings**
28+
2.**License Settings**
2629

2730
Allows permission, condition, limitation comparison and selection of licenses provided by Github.
2831

29-
**3. Pull-Request Template Settings**
32+
3.**Pull-Request Template Settings**
3033

3134
Sorting and providing various pull-request templates in githubstar order, selecting or modifying the templates to suit your needs, or creating new ones.
3235

33-
**4. Issue Template Settings**
36+
4.**Issue Template Settings**
3437

3538
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.
3639

37-
**5. CONTRIBUTING.md Settings**
40+
5.**CONTRIBUTING.md Settings**
3841

3942
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.
4043

41-
**6. README.md Settings**
44+
6.**README.md Settings**
4245

4346
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.
4447

45-
**7. Complete Project Creation**
48+
7.**Complete Project Creation**
4649

47-
When you complete the creation of the project, you send mail to which the documentations are connected.
48-
In the repository that you created, the documents you set are committed and pushed.
50+
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.
4951

5052
### Review
51-
**1. Select a repository**
53+
54+
1.**Select a repository**
5255

5356
When you proceed with yourself or membership/login, choose a repository that has more than push permission from the authorized organization.
5457

55-
**2. Project Operational Assessment**
58+
2.**Project Operational Assessment**
59+
5660
Divided into templates, communities, and security, the parts that have not been evaluated are marked in red circles.
5761

5862
- 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/)
5963
- Community checks whether Description, Code of Conduct, Discussion, and License are enabled. [More about Community](https://docs.open-set-go.com/docs/guideForClient/aboutcommunity/)
6064
- Security checks whether Security Policy, Dependabot, CodeQL, Secret Scanning is enabled. [More about Security](https://docs.open-set-go.com/docs/guideForClient/aboutsecurity/)
6165

62-
**3. Project Operational Assessment**
66+
3.**Project Operational Assessment**
6367

6468
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.
6569

66-
**4. Create Pull Request**
70+
4.**Create Pull Request**
6771

68-
If you make a new template through number 3, make a Pull Request.
72+
If you make a new template through number 3, make a Pull Request.

0 commit comments

Comments
 (0)