cloud-native-toolkit / cloud-native-toolkit/planning

Improve Guide using feedback from the Architecture Center editors

Open
#329 0 comments 0 reactions 0 assignees View on GitHub
bug documentation Epic
Dominant language
No language data
Stars
4
Forks
1
PR merge metrics
No merged PRs in 30d

Description

- Need to review which product icons can be used

**Icons**

These are the product icons that I found in the toolkit:

Jenkins
Tekton
Pact Broker
Hoverfly
ArgoCD
Razee
Sonar Qube
Artifactory
Nexus
Jmeter
Jaeger
Swagger
Aqua
Twistlock
LogDNA
SysDig
VSCode
IntellJ
Code Ready
Eclipse CHE
Docker

I cross-checked with David's list ( https://ibm.box.com/s/1v7htf6p05ur7p5alwgf1c2wqbea8jjb) and the only common icon is Docker, which we have listed as "not approved". Others may be approved (like Jenkins), but they are not on the list.

A few observations from a quick run-through of the document:

1. Inconsistent use of cloud native vs. cloud-native. Most of the document uses "cloud native", which isn't the IBM-approved style, but there are several places where cloud-native is used.

1. On my quick run through, I noticed a few typos - It doesn't look like it was edited. A few examples:
https://cloudnativetoolkit.dev/overview

- "The heart of the is a cluster:
• An or 3-node cluster"

- https://cloudnativetoolkit.dev/getting-started/dashboard -> Tekon instead of Tekton in diagram

- https://cloudnativetoolkit.dev/contributing - Last 2 sections are labeled 8 & 9, where are 1-7?

1. Inconsistent punctuation and formatting. Periods are not used at the end of most sentences in steps.

- https://cloudnativetoolkit.dev/getting-started/deploy-app

1. Give It a Try sections and other tutorial-type pages could use numbering and formatting: https://cloudnativetoolkit.dev/guides/code-analysis https://cloudnativetoolkit.dev/practical/inventory-part2

-- From email "Cloud-native Developer Toolkit observations" on 05/07/2020 09:49 AM and May 6, 2020 at 2:23:20 PM EDT

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.