Wiki Content Label List

 

Confidence Level TBD  This article has not been reviewed for accuracy, timeliness, or completeness. Check that this information is valid before acting on it.

Confidence Level TBD  This article has not been reviewed for accuracy, timeliness, or completeness. Check that this information is valid before acting on it.

 

 

his serves as a list of pages that need work, each page is labelled according to what stage it is in.

For information on how to write documentation, please refer to the Style Guide.

Labels: ok, in_progress, unfinished, needs_update, create_content, delete.



delete: This page is likely to be deprecated but needs review before being deleted.

create_content: This page is a stub or missing content entirely, a placeholder for a page that needs to be written.

unfinished: This page has content but is not considered functional.

in_progress: This page is functional but incomplete.

needs_update: This page is possibly out of date and needs review by someone knowledgable on the subject.

ok: Someone knowledgable on the subject has signed off on this page's accuracy.


 


The following tags are proposed for content tagging and navigation, July 2020:

Proposal:

Each document will have the following labels:

1 content type label

1+ tech labels

1+ hysds specific labels

1+ content variables label

1 ?? housekeeping

1 SME label

= total of at least 6 labels

 

Content Type:

Subject Matter Expert:

Page Maintainer:

hysds_setup

needs_sme

needs_pm

step_by_step_guides

sme_assigned

pm_assigned

reference

update_sme

update_pm

cheatsheets

 

 

development

 

 

 

Tech Labels:

HySDS Specific:

Content Variables:

aws

tosca

hysds_setup

linux

figaro

operations_manual

python

mozart

diagram

elasticsearch

factotum

onboarding

kibana

verdi

troubleshooting

logstash

grq

version_3.0

rabbitmq

job_management

Version_2.0

celery

tasks

version_1.0

supervisord

workers

 

jenkins

sdswatch

 

docker

pge

 

github

provenance

 

terraform

metrics

 

sciflo

chimera

 

json

tasks

 

api

pleiades

 

ports

pcm

 

azure

 

 

yaml

 

 

 

 

 

 

 

 

 

 

 

 

Content Type (stateful):

Tech Labels:

HySDS Specific:

Content Variables:

Subject Matter Expert (stateful):

“Housekeeping” ??:

Content Type (stateful):

Tech Labels:

HySDS Specific:

Content Variables:

Subject Matter Expert (stateful):

“Housekeeping” ??:

1

hysds_setup

aws

tosca

hysds_setup

needs_sme

review_for_redundancy

2

step_by_step_guides

linux

figaro

operations_manual

sme_assigned

content_updated_2020

3

reference

python

mozart

diagram

update_sme

content_updated_2019

4

cheatsheets

elasticsearch

factotum

onboarding

 

content_updated_2018

5

development

kibana

verdi

troubleshooting

 

content_updated_2016

6

 

logstash

grq

version_3.0

 

content_updated_2017

7

 

rabbitmq

job_management

Version_2.0

 

 

8

 

celery

tasks

version_1.0

 

footer_updated

9

 

supervisord

workers

 

 

Potentially incorporate SME tags here:

10

 

jenkins

sdswatch

 

 

needs_sme

11

 

docker

pge

 

 

sme_assigned

12

 

github

provenance

 

 

update_sme

13

 

terraform

metrics

 

 

 

14

 

sciflo

chimera

 

 

Additional Tags:

15

 

json

tasks

 

 

community

16

 

api

pleiades

 

 

wiki_development

17

 

ports

pcm

 

 

meeting-notes (already exists, wasn’t used)

18

 

azure

 

 

 

 

19

 

yaml

 

 

 

 

20

 

 

 

 

 

 

21

 

 

 

 

 

 

22

 

 

 

 

 

 

BOLD = used in wiki

NOT BOLD = proposed but not yet applied to anything in the wiki

 

7/13: Spencer tag up feedback: Prerequisite box (via Content by Label macro) along top of article populated by potential “implicit technologies” and/or “access/permissions requirements

Note: the prerequisite content doesn’t always need to be label-based and pointing to wiki docs.

 

TODO: per Lan, structure tags in a table format for horizontal viewing.

Style Guide vs Doc Development Guide:

feedback from meetup:

Goal: doc development guide will help getting the wiki organized so that it can transition to maintenance mode.

Per doc community, the style guide:

  • it gives a set of rules or guidelines for how to write your docs. One point: define a word list, so the same words are used in the same way. Project specific word lists which can include hysds specific terms or technical terms but has one specific meaning in terms of hysds context

  • speak with a uniform voice. the documents should all sound like they're written by the same person

  • "Linting text", see an example: https://github.com/get-alex/alex  TODO: research linters and see if it can be incorporated into workflow (TODO: follow up with Lan about using confluence API for linting)

  • https://www.writethedocs.org/guide/writing/style-guides/



Doc Development Guide:

  • Goal: figure out how to organize all of the content

  • Discoverable, eliminate confusing/incorrect docs, identifying needed onboarding docs

  • How to put together onboarding docs.








Top priority articles:

Contribution Guide, Community Roadmap, FAQ, Style Guide.



Any given page should only have one of these labels. If you feel, after reviewing a page, that it is labeled inaccurately, change the label. Be sure to remove the old label.



Click any of these links to be taken to a list of pages with that label.

(if the page is not found or there is nothing listed under the link, there are no pages with that label.)

Delete

Create Content

Unfinished

In Progress

Needs Update

OK








Related Articles:

Related Articles:

Have Questions? Ask a HySDS Developer:

Anyone can join our public Slack channel to learn more about HySDS. JPL employees can join #HySDS-Community

JPLers can also ask HySDS questions at Stack Overflow Enterprise

Page Information:

Page Information:

Was this page useful?

Yes No

Contribution History:

Subject Matter Expert:

@Marjorie Lucas

@Lan Dang

Find an Error?

Is this document outdated or inaccurate? Please contact the assigned Page Maintainer:

@Marjorie Lucas



Note: JPL employees can also get answers to HySDS questions at Stack Overflow Enterprise: