Skip to content

Commit 6026501

Browse files
committed
Update 0007-porter.md: fix format, skip link check for Google doc
Signed-off-by: Patrice Chalin <[email protected]>
1 parent 02e2c9e commit 6026501

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

analyses/0007-porter.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,8 @@
11
---
2-
title: Porter tech docs assessment draft
2+
title: Porter docs analysis
33
cSpell:ignore: Uchechukwu Obasi
44
---
55

6-
# Notes
7-
8-
meeting notes:
9-
https://docs.google.com/document/d/12OGtSaUtlc7OA_iPnUvmVaiKg8yM7_QBzFnMgoHvnLw/edit?usp=sharing
10-
website: https://getporter.org/ repos:
11-
12-
- https://github.com/getporter/porter (main site), site content is in docs/
13-
folder
14-
- https://github.com/getporter/operator (https://getporter.org/operator site)
15-
166
# Porter Docs Assessment
177

188
Prepared by:
@@ -22,6 +12,15 @@ Prepared by:
2212

2313
Date: 2023-04-07
2414

15+
Resources:
16+
17+
- [Meeting notes](https://docs.google.com/document/d/12OGtSaUtlc7OA_iPnUvmVaiKg8yM7_QBzFnMgoHvnLw?no-link-check)
18+
- Website: <https://getporter.org>
19+
- Repos:
20+
- Main site: <https://github.com/getporter/porter>. Content is in `docs`.
21+
- [Operator site](https://getporter.org/operator):
22+
<https://github.com/getporter/operator>
23+
2524
## Introduction
2625

2726
This document assesses the quality and completeness of a project's documentation
@@ -159,7 +158,7 @@ Scale:
159158

160159
- Move the website sourcefile to a separate "website" directory. That way, we
161160
create a good separation of concern. A good example is
162-
[https://github.com/thanos-io/thanos](https://github.com/thanos-io/thanos).
161+
<https://github.com/thanos-io/thanos>.
163162
- The porter's docs should be searchable.
164163
- Create a version picker (dropdown) to make search easily discoverable for
165164
users.

0 commit comments

Comments
 (0)