Skip to content

Commit c0859ee

Browse files
authored
Merge pull request #70 from geopozo/andrew/docs
New docs build
2 parents 1325919 + 156a0b9 commit c0859ee

6 files changed

Lines changed: 46 additions & 22 deletions

File tree

site/images/release_audit.png

126 KB
Loading

site/index.html

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@
230230
<li class="md-nav__item">
231231
<a href="#supported-interfaces" class="md-nav__link">
232232
<span class="md-ellipsis">
233-
Supported Interfaces:
233+
Supported Interfaces
234234
</span>
235235
</a>
236236

@@ -255,9 +255,9 @@
255255
</li>
256256

257257
<li class="md-nav__item">
258-
<a href="#example-verison-audit" class="md-nav__link">
258+
<a href="#example-version-audit" class="md-nav__link">
259259
<span class="md-ellipsis">
260-
Example Verison Audit
260+
Example Version Audit
261261
</span>
262262
</a>
263263

@@ -270,6 +270,15 @@
270270
</span>
271271
</a>
272272

273+
</li>
274+
275+
<li class="md-nav__item">
276+
<a href="#example-release-inspection-platforms" class="md-nav__link">
277+
<span class="md-ellipsis">
278+
Example Release Inspection (Platforms)
279+
</span>
280+
</a>
281+
273282
</li>
274283

275284
</ul>
@@ -329,7 +338,7 @@
329338
<li class="md-nav__item">
330339
<a href="#supported-interfaces" class="md-nav__link">
331340
<span class="md-ellipsis">
332-
Supported Interfaces:
341+
Supported Interfaces
333342
</span>
334343
</a>
335344

@@ -354,9 +363,9 @@
354363
</li>
355364

356365
<li class="md-nav__item">
357-
<a href="#example-verison-audit" class="md-nav__link">
366+
<a href="#example-version-audit" class="md-nav__link">
358367
<span class="md-ellipsis">
359-
Example Verison Audit
368+
Example Version Audit
360369
</span>
361370
</a>
362371

@@ -369,6 +378,15 @@
369378
</span>
370379
</a>
371380

381+
</li>
382+
383+
<li class="md-nav__item">
384+
<a href="#example-release-inspection-platforms" class="md-nav__link">
385+
<span class="md-ellipsis">
386+
Example Release Inspection (Platforms)
387+
</span>
388+
</a>
389+
372390
</li>
373391

374392
</ul>
@@ -392,31 +410,37 @@ <h1>Readme</h1>
392410
<p><em>github-helper</em> is an API connector to help engineering managers quickly check the
393411
status of one or ALL repositories at the same time.</p>
394412
<p>It has a python, CLI, json, and HTML interface.</p>
395-
<h3 id="supported-interfaces">Supported Interfaces:</h3>
413+
<h2 id="supported-interfaces">Supported Interfaces</h2>
396414
<ul>
397415
<li>local git repo</li>
398416
<li>git tags via github</li>
399417
<li>github releases</li>
400418
<li>pypi</li>
401419
<li>pypi testing</li>
402-
<li>conda</li>
420+
<li>conda (coming)</li>
403421
</ul>
404-
<h3 id="version-auditing">Version Auditing</h3>
422+
<h2 id="version-auditing">Version Auditing</h2>
405423
<p>It ensures that versions are the same across sources, and that the builds are
406-
also the same (same platforms supported). It notified you of discrepencies.</p>
424+
also the same (same platforms supported). It notified you of discrepancies.</p>
407425
<p>It allows you to set template rules for github and audits your rulesets to make
408-
sure they are in comformance.</p>
426+
sure they are in conformance.</p>
409427
<p>In fact, it can provide a tree-diff for any type of configuration file
410428
(pre-commits, GHA, etc).</p>
411429
<p>It allows you to check its access level (public private archived), as well as
412430
who has access.</p>
413-
<h3 id="example-repo-html-interface">Example Repo HTML Interface</h3>
414-
<p><a href="repos.html">Example</a></p>
415-
<p><img alt="Screenshot of Repos HTML Output" src="images/repos_html_interface.png" /></p>
416-
<h3 id="example-verison-audit">Example Verison Audit</h3>
417-
<p><img alt="Screenshot of Multi-Version Output" src="images/version_audit.png" /></p>
418-
<h3 id="example-single-version-inspection-incomplete">Example Single-Version Inspection (Incomplete)</h3>
419-
<p><img alt="Screenshot of Terminal Output" src="images/single_version_audit.png" /></p>
431+
<h2 id="example-repo-html-interface">Example Repo HTML Interface</h2>
432+
<p><a href="repos.html">Example (Click)</a></p>
433+
<p>Click to expand</p>
434+
<p><a href="images/repos_html_interface.png"> <img alt="Screenshot of Repos HTML Output" src="images/repos_html_interface.png" /> </a></p>
435+
<h2 id="example-version-audit">Example Version Audit</h2>
436+
<p>Click to expand</p>
437+
<p><a href="images/version_audit.png"> <img alt="Screenshot of Multi-Version Output" src="images/version_audit.png" /> </a></p>
438+
<h2 id="example-single-version-inspection-incomplete">Example Single-Version Inspection (Incomplete)</h2>
439+
<p>Click to expand</p>
440+
<p><a href="images/single_version_audit.png"> <img alt="Screenshot of Terminal Output Single Version" src="images/single_version_audit.png" /> </a></p>
441+
<h2 id="example-release-inspection-platforms">Example Release Inspection (Platforms)</h2>
442+
<p>Click to expand</p>
443+
<p><a href="images/release_audit.png"> <img alt="Screenshot of Terminal Output Releases" src="images/release_audit.png" /> </a></p>
420444

421445

422446

site/jsons/github_helper.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

site/repos.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1419,7 +1419,7 @@
14191419
<td class="repo"><a href="https://www.github.com/geopozo/pozo-py-premium" target="_blank">pozo-py-premium</a></td>
14201420
<td class="text-center"><span >heads/main</span></td>
14211421
<td ><span ></span></td>
1422-
<td class="description"><span >La versión profesional de pozo-py/Premium version of pozo-py</span></td>
1422+
<td class="description"><span >La versión professional de pozo-py/Premium version of pozo-py</span></td>
14231423
<td class="collaborators"><a href="https://www.github.com/geopozo/pozo-py-premium/settings/access" target="_blank">🔧</a><a href="https://www.github.com/ayjayt" class="collaborator" target="_blank" title="Full access to the repository, including settings and collaborators.">ayjayt<sup class="badge">4</sup></a><a href="https://www.github.com/davidangarita1" class="collaborator" target="_blank" title="Can read, clone, and push to this repository">davidangarita1<sup class="badge">2</sup></a></td>
14241424
<td class="topics"><a href="https://www.github.com/geopozo/pozo-py-premium" target="_blank">🔧</a></td>
14251425
</tr><tr class="repo-row private ">

site/sitemap.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://github.com/geopozo/github-helper/</loc>
5-
<lastmod>2025-05-15</lastmod>
5+
<lastmod>2025-05-20</lastmod>
66
</url>
77
<url>
88
<loc>https://github.com/geopozo/github-helper/api/github_helper/</loc>
9-
<lastmod>2025-05-15</lastmod>
9+
<lastmod>2025-05-20</lastmod>
1010
</url>
1111
</urlset>

site/sitemap.xml.gz

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)