Skip to content

Commit bdd7008

Browse files
authored
Consolidate module metadata (#50)
* Fix website accessibility and module index * Consolidate module metadata * Remove unused IE compatibility scripts * Clarify repository-only entries in module metadata
1 parent a0e0990 commit bdd7008

5 files changed

Lines changed: 49 additions & 29 deletions

File tree

_data/index/modules.yml

Lines changed: 0 additions & 4 deletions
This file was deleted.

_data/modules.yml

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,48 @@
22
description: A PowerShell module that interacts with Atlassian's Confluence wiki product.
33
github: https://github.com/AtlassianPS/ConfluencePS
44
path: /module/ConfluencePS
5+
docs: /docs/ConfluencePS
6+
gallery: https://www.powershellgallery.com/packages/ConfluencePS
57
status: active
68
- name: JiraAgilePS
79
description: PowerShell module to interact with Jira's Agile plugin
810
github: https://github.com/AtlassianPS/JiraAgilePS
911
path: /module/JiraAgilePS
12+
docs: /docs/JiraAgilePS
13+
gallery: https://www.powershellgallery.com/packages/JiraAgilePS
1014
status: active
1115
- name: JiraPS
12-
description: PowerShell module to interact with Atlassian JIRA
16+
description: PowerShell module to interact with Atlassian Jira.
1317
github: https://github.com/AtlassianPS/JiraPS
1418
path: /module/JiraPS
19+
docs: /docs/JiraPS
20+
gallery: https://www.powershellgallery.com/packages/JiraPS
1521
status: active
1622
- name: AtlassianPS.Configuration
17-
description: A module for AtlassianPS modules to use for managing connections
23+
description: Shared connection and server configuration for AtlassianPS modules.
1824
github: https://github.com/AtlassianPS/AtlassianPS.Configuration
1925
path: /module/AtlassianPS.Configuration
26+
docs: /docs/AtlassianPS.Configuration
27+
gallery: https://www.powershellgallery.com/packages/AtlassianPS.Configuration
2028
status: active
2129
- name: AtlassianPS
22-
description: Legacy metapackage; not an active documentation target.
30+
description: Repository for cross-cutting AtlassianPS issues and coordination.
2331
github: https://github.com/AtlassianPS/AtlassianPS
2432
path: /module/AtlassianPS
25-
status: legacy
33+
docs:
34+
gallery:
35+
status: repository
2636
- name: BitbucketPS
27-
description: Legacy Bitbucket module; not an active documentation target.
37+
description: Historical Bitbucket repository; not an active website documentation target.
2838
github: https://github.com/AtlassianPS/BitbucketPS
2939
path: /module/BitbucketPS
30-
status: legacy
40+
docs:
41+
gallery:
42+
status: repository
3143
- name: HipChatPS
32-
description: Legacy HipChat module; not an active documentation target.
44+
description: Historical HipChat repository; not an active website documentation target.
3345
github: https://github.com/AtlassianPS/HipChatPS
3446
path: /module/HipChatPS
35-
status: legacy
47+
docs:
48+
gallery:
49+
status: repository

_data/navigation.yml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,8 @@
33
childs:
44
- name: AtlassianPS.Configuration
55
path: module/AtlassianPS.Configuration
6-
# - name: BitbucketPS
7-
# path: module/BitbucketPS
86
- name: ConfluencePS
97
path: module/ConfluencePS
10-
# - name: HipChatPS
11-
# path: module/HipChatPS
128
- name: JiraAgilePS
139
path: module/JiraAgilePS
1410
- name: JiraPS
@@ -22,8 +18,6 @@
2218
- name: Gallery
2319
path: docs/Gallery
2420
listChilds: true
25-
# - name: BitbucketPS
26-
# path: docs/BitbucketPS
2721
- name: AtlassianPS.Configuration
2822
path: docs/AtlassianPS.Configuration
2923
groups:
@@ -41,8 +35,6 @@
4135
groups:
4236
- About
4337
- Commands
44-
# - name: HipChatPS
45-
# path: docs/HipChatPS
4638
- name: JiraPS
4739
path: docs/JiraPS
4840
groups:

_includes/sections/modules.html

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,33 @@
11
<div class="row module-wrapper">
2-
{% for module in site.data.index.modules %}
2+
{% assign activeModules = site.data.modules | where: "status", "active" %}
3+
{% for module in activeModules %}
34
<div
45
user="AtlassianPS"
56
repo="{{ module.name }}"
67
class="module item col-10 col-md-5 ml-auto mr-auto"
78
>
89
<div class="module-item">
9-
<a class="link" href="/module/{{ module.name }}">
10+
<a class="link" href="{{ module.path }}">
1011
<img
1112
src="/assets/img/{{ module.name }}.png"
1213
class="logo img-responsive"
1314
alt="{{ module.name }}"
1415
/>
1516
<h3 class="item-title">{{ module.name }}</h3>
1617
</a>
17-
<p class="item-description"></p>
18+
<p class="item-description">{{ module.description }}</p>
1819
<div class="ghbtn">
1920
<a
2021
target="_blank"
21-
href="#"
22+
href="{{ module.github }}"
2223
class="btn btn-xs btn-white html_url"
2324
alt="Repository"
2425
>
2526
<i class="fab fa-github"></i>
2627
</a>
2728
<a
2829
target="_blank"
29-
href="https://github.com/AtlassianPS/{{ module.name }}/issues"
30+
href="{{ module.github }}/issues"
3031
class="btn btn-xs btn-white repo"
3132
alt="Report Issue"
3233
>
@@ -35,22 +36,22 @@ <h3 class="item-title">{{ module.name }}</h3>
3536
<br />
3637
<a
3738
target="_blank"
38-
href="https://www.powershellgallery.com/packages/{{ module.name }}"
39+
href="{{ module.gallery }}"
3940
class="btn btn-xs btn-white gallery"
4041
alt="Gallery Downloads"
4142
>
4243
<i class="fas fa-cloud-download-alt"></i> ...</a
4344
>
4445
<a
4546
target="_blank"
46-
href="https://github.com/AtlassianPS/{{ module.name }}/stargazers"
47+
href="{{ module.github }}/stargazers"
4748
class="btn btn-xs btn-white star"
4849
>
4950
<i class="fas fa-star"></i> ...</a
5051
>
5152
<a
5253
target="_blank"
53-
href="https://github.com/AtlassianPS/{{ module.name }}/network"
54+
href="{{ module.github }}/network"
5455
class="btn btn-xs btn-white fork"
5556
>
5657
<i class="fas fa-code-branch"></i> ...</a

pages/module.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,13 @@ permalink: /module/
88

99
AtlassianPS maintains PowerShell modules for Atlassian products and shared AtlassianPS configuration.
1010

11+
{% assign activeModules = site.data.modules | where: "status", "active" %}
12+
{% assign otherRepositories = site.data.modules | where: "status", "repository" %}
13+
14+
## Active modules
15+
1116
<div class="row module-wrapper">
12-
{% for module in site.data.modules %}
17+
{% for module in activeModules %}
1318
<div class="module item col-12 col-md-6">
1419
<div class="module-item card h-100">
1520
<div class="card-body">
@@ -20,10 +25,22 @@ AtlassianPS maintains PowerShell modules for Atlassian products and shared Atlas
2025
<p>{{ module.description }}</p>
2126
<p>
2227
<a class="btn btn-square btn-outline" href="{{ module.path }}">Module details</a>
28+
{% if module.docs %}<a class="btn btn-square btn-outline" href="{{ module.docs }}">Documentation</a>{% endif %}
2329
<a class="btn btn-square btn-outline" href="{{ module.github }}">Source code</a>
30+
{% if module.gallery %}<a class="btn btn-square btn-outline" href="{{ module.gallery }}">PowerShell Gallery</a>{% endif %}
2431
</p>
2532
</div>
2633
</div>
2734
</div>
2835
{% endfor %}
2936
</div>
37+
38+
## Other repositories
39+
40+
These repositories are part of AtlassianPS, but they are not published modules on this website.
41+
42+
<ul>
43+
{% for module in otherRepositories %}
44+
<li><a href="{{ module.github }}">{{ module.name }}</a>: {{ module.description }}</li>
45+
{% endfor %}
46+
</ul>

0 commit comments

Comments
 (0)