Versions Compared

Old Version 44

changes.mady.by.user Craig Willis

Saved on

compared with

New Version Current

changes.mady.by.user Craig Willis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Add links to new documentation
  • Revisit description
    • Add an FAQ?
    DocumentPriorityNotesAssigneeReviewerStatusRelated Link(s)
    Official NDS DomainHigh
    • http://www.nationaldataservice.org/ footer contains link to out-of-date Wiki. Text is wrong, link is right.
    • http://www.nationaldataservice.org/ "Get Involved" and top menu contain links to page to subscribe to mailing list – including discuss. We need to decide whether "discuss" will continue to be used.
    • Confluence has pilots and projects conflated.
    • News is really out of date
    • Revisit / review the "Labs" page, which is largely inaccurate. Also, likely need to distinguish between "NDS Labs as OpenStack" and "NDS Labs Workbench"
      • How to request access: stays on main site
      • Other content move to Confluence
      • Do you have to have an approved pilot to access the Workbench? Open question for TAC/Steering committee
        • Pilots need to use Workbench to come up with the pilot idea
        • Workbench is one of the many services offered by NDS Labs
          • 2 cases: explore (pre-pilot test drive), develop (pilot)
          • Pre-pilot = NDSC member, RDA member?
            • We need NDSC developers that are not pilot members to have access to contribute tools
          • Pilots need more resources (e.g., PRAGMA) – outgrow Workbench
          • Workbench has two services: test drive and developer
      • Add pilot request form link https://docs.google.com/forms/d/e/1FAIpQLScl23mQJxUB9p0zWhtjDneBdQHfd48vv790uMgfrvF_3UAtmw/viewform?c=0&w=1
    • Add links to Confluence to replace labsportal
    		   
      

    Footer: Move Github so that it's the first link under "NDS Project Resources"

    		PR/Kandace   
      What should NDS Provide: Broken link to NDS Services DiagramPR/Kandace   
      

    Pilot projects:

    • Need to add: SBGrid, NIST (materials registry/curation , Pragma descriptions.
    		PR/Kandace   
      

    Get Involved

    • Remove Trello link
    • Move Github to first position
    		PR/Kandace   
      

    Labs:

    		PR/Kandace   
      

    Pilot application

    • If we are going to continue with pilot applications...
    • Remove labsportal link.
    • Distinguish from "NDS Labs" Workbench
    		PR/Kandace   
    Labs PortalHigh   
      Move to Wiki an revise as needed http://labsportal.nationaldataservice.org/accessing-ndslabs/    
      

    Remove all other content/decommission site

    		    
    NCSA Opensource ConfluenceHigh
    • Remove duplicate content
    • Add a note pointing to official NDS Confluence documentation
    • Consider securing NDS space within NCSA Confluence - use this for internal notes
    • Development, project management, in progress
    • Q. Should this be migrated to hosted Confluence (e.g., JIRA)
    		   
    NDS ConfluenceHigh
    • Review public documentation
    • Fill out more details on template stubs
    		   
    NCSA Confluence     
    YouTube ChannelHigh
    • Update descriptions
    • Ensure that videos make sense
    		   
    Google GroupHigh

     

    		   
    • Jira
      serverJIRA
      serverIdb14d4ad9-eb00-3a94-88ac-a843fb6fa1ca
      keyNDS-156
      

    Footer:

    • Move Github so that it's the first link under "NDS Project Resources"
    		PR/Kandace   
      

    What should NDS Provide:

    • Broken link to NDS Services Diagram (behind protected area in Wiki?)
    		PR/Kandace   
      

    Pilot projects:

    • Add descriptions for: SBGrid, NIST (materials registry/curation), Pragma projects.
    		PR/Kandace   
      

    Get Involved

    • Remove Trello link
    • Move Github to first position
    		PR/Kandace   
      

    Labs:

    		PR/Kandace   
      

    Pilot application

    If we are going to maintain both the Workbench registration and pilot application, we'll need to update the pilot application.

    • Distinguish from Workbench
    • Remove labsportal link.

    		PR/Kandace   
      

    Open questions/Undecided

    • "Get Involved" and top menu contain links to page to subscribe to mailing list – including discuss. We need to decide whether "discuss" will continue to be used.
    • News is really out of date
    • Do you have to have an approved pilot to access the Workbench? (Open question for TAC/Steering committee)
      • Pilots need to use Workbench to come up with the pilot idea
      • Workbench is one of the many services offered by NDS Labs
        • 2 cases: explore (pre-pilot test drive), develop (pilot)
        • Pre-pilot = NDSC member, RDA member?
          • We need NDSC developers that are not pilot members to have access to contribute tools
        • Pilots need more resources (e.g., PRAGMA) – outgrow Workbench
        • Workbench has two services: test drive and developer
    		    
    Labs PortalHighCraig Done
    • Jira
      serverJIRA
      serverIdb14d4ad9-eb00-3a94-88ac-a843fb6fa1ca
      keyNDS-327
      Move to Wiki an revise as needed http://labsportal.nationaldataservice.org/accessing-ndslabs/Kenton Done 
      

    Remove all other content/decommission site

    		Craig Done 
    NCSA Opensource ConfluenceHigh

    The NCSA Opensource confluence will be used primarily for development, project management, and in-progress documentation going forward.

    		   
      
    • Identify and remove duplicate content
    		   See Confluence audit below
      
    • Add a note pointing to official NDS Confluence documentation
    		Craig   
      

    Open questions

    • Q. Should this be migrated to hosted Confluence (e.g., JIRA)
    • Consider securing NDS space within NCSA Confluence - use this for internal notes
    		    
    NDS ConfluenceHigh
    • Review public documentation
    • Fill out more details on template stubs
    		   
    NCSA Confluence Craig DoneAdded note on front page
    YouTube ChannelHigh
    • Update descriptions
    • Ensure that videos make sense
    		   
    Google GroupHigh
    • Add links to new documentation
    • Revisit description
    • Add an FAQ?
    		CraigMikeReady for review
    Tutorial repo with examplesHigh
    • Update with new examples?
    • Make sure old ones still work
    		MikeCraig 
    FAQHigh
    • Add contents to the FAQ
    		Craig  
    User GuideHigh
    • Review
    		CraigMike

    Ready for Review

    Developer GuideHigh
    • Finish filling out Developer Guide
    • Needs more about authoring dockerfiles / builds / etc
    		Craig +Mike  
    Docker HubMedium
    • Review Automated Builds (see audit table below)
    		See belowSee belowSee below
    GitHubMedium
    • Review READMEs (see audit table below)
    • Delete unecessary repos
      • k8s-ingress
      • kubernetes
      • contrib?
      • invenio
      • data-provider
      • glopy
      • scidrive
    • Flatten out Service repos
      • Remove k8 specs
      • Move Dockerfiles to root
    • Clean-up Clowder
    		See belowSee belowSee below
    BitBucketMedium
    • Craig to add readme with link to github
      • Unable to actually add readme, but changed project URL
    		CraigMikeTo be reviewed

     

    Unable to actually add readme, but changed project URL.

     

    Other Wikis?Low
    • Archive
    		   
    Architecture DocsLow
    • Make sure these reflect reality
    		   
           

    Confluence audit

    Page

    Owner/

    Creator

    		Notes
    NDS LabsKenton

    Archive given new content? https://nationaldataservice.atlassian.net/wiki/display/NDSC/NDS+Labs

    Kenton: Lets keep this as this is the dev wiki for planning and documenting activities specific to Labs.  Perhaps should add a note making this clear.  Most of the work here may be in better organizing NDS Labs Design Documentation where most of the material is at.

    NDS Labs OverviewKenton

    Archive?

    Moved under NDS Labs Design Documentation

    NDS Labs ArchitectureDavidOut of date, needs to be updated and should be moved to official Wiki
    NDS Labs APICraigOut of date, should be archived and a link to the actual API documentation included on official Wiki
    NDS Labs Web InterfaceKenton

    Out of date, should be archived

    Kenton: Moved under NDS Labs Design Documentation

    NDS Labs ExamplesKenton

    Out of date, should be archived

    Kenton: Moved under NDS Labs Design Documentation

    NDS Labs Service SpecificationCraigOut of date, should be archived, already links to ndslabs-specs repo.
    NDS Labs Test CasesCraigMaybe archive? If already included in Mike's test plans
    NDS Labs Design DocumentationAllKeep, still valid. Could be reorganized.
    Developer WorkflowsMikeKeep, still valid.
    GlossaryMike?
    Pilot architecturesCraigTBD. Possibly move to official Wiki. Or maybe this is just useful for me
    Towards Developer and Development GroupsDavid

    Mockups for developer support, should be archived or moved to design

    Kenton: Moved under NDS Labs Design Documentation

    Concepts for Developer SupportDavid

    Mockups for developer support, looks like duplicate

    Kenton: Moved under NDS Labs Design Documentation

    Beta ReleaseCraigBeta release features, can be archived since this already exists on official Wiki
    NDS ShareKentonKeep

     

     

    Repositories and automated builds audit

    Git RepoDocker repo

    Dockerhub

    Build type

    		ReadmeOwnerReviewerStatusNotes/What is it used for?.
    angular-terminal-test NA Mike   

    core

    		 NA Mike  Fork of Cloud9 core
    data-provider-interface NA    Legacy - can be deleted
    developer-tutorial

    https://hub.docker.com/r/ndslabs/cowsay-php/

    		manual     
     https://hub.docker.com/r/ndslabs/cloud9/manual     
     https://hub.docker.com/r/ndslabs/cowsay/manual     
    geospatial-search-demo NA    Legacy - can be deleted
    glopy NA David?  Fork of Python Globus toolkit
    glusterhttps://hub.docker.com/r/ndslabs/gluster/autorevisitDavid  System component. Readme seems out of date.
    inveniohttps://hub.docker.com/r/ndslabs/invenio/auto Craig  Incomplete service should be noted in readme
    k8-labels NA Mike  Do we still need this?
    k8s-ingress-nginx NA Craig  Do we still need this?
    kubernetes

    https://hub.docker.com/r/ndslabs/hyperkube/

    https://hub.docker.com/r/ndslabs/kube-controller-manager-amd64/

    https://hub.docker.com/r/ndslabs/kube-scheduler-amd64/

    https://hub.docker.com/r/ndslabs/hyperkube-amd64/`

    https://hub.docker.com/r/ndslabs/kube-apiserver-amd64/

    https://hub.docker.com/r/ndslabs/kube-proxy-amd64/

    https://hub.docker.com/r/ndslabs/kube-proxy-arm/

    		Manual David  Do we still need these?
    logspouthttps://hub.docker.com/r/ndslabs/logspout/autoforkCraig  Used in Labs Workbench
    nagios-config NArevisitCraig  Current Nagios configuration repo. Readme is incomplete.
    nds-labs-legacy NA    Legacy noted in description
    ndslabs

    https://hub.docker.com/r/ndslabs/angular-ui/

    		auto Mike   
     https://hub.docker.com/r/ndslabs/apiserver/autorevisitCraig  Used in Labs Workbench. Readme is out of date
     https://hub.docker.com/r/ndslabs/ndslabs-gui/manual Mike  Retained for 1.0.0 compatibility
    ndslabs-all-sources NA David  Do we really need this? Does anyone use it?
    ndslabs-chiselhttps://hub.docker.com/r/ndslabs/chisel/autookCraig  Used in Labs Workbench
    ndslabs-clowder

    https://hub.docker.com/r/ndslabs/clowder/

    https://hub.docker.com/r/ndslabs/audio-preview/

    https://hub.docker.com/r/ndslabs/image-metadata/

    https://hub.docker.com/r/ndslabs/pdf-preview/

    https://hub.docker.com/r/ndslabs/speech2text/

    https://hub.docker.com/r/ndslabs/image-preview/

    https://hub.docker.com/r/ndslabs/video-preview/

    https://hub.docker.com/r/ndslabs/plantcv/

    https://hub.docker.com/r/ndslabs/image-extractor-base/

    		  Mike   
    ndslabs-dataverse

    https://hub.docker.com/r/ndslabs/dataverse/

    		autorevisitCraig  All components share a single readme, which is out of date (mentions of Kubernetes?)
     https://hub.docker.com/r/ndslabs/dataverse-icat/auto Craig   
     https://hub.docker.com/r/ndslabs/dataverse-rserve/auto Craig   
     https://hub.docker.com/r/ndslabs/solr/auto Craig  Should be dataverse-solr
     https://hub.docker.com/r/ndslabs/tworavens/auto Craig   
    ndslabs-deploy-toolshttps://hub.docker.com/r/ndslabs/deploy-tools/auto David   
    ndslabs-developer-shellhttps://hub.docker.com/r/ndslabs/ndsdev/manual David   
    ndslabs-devenvs

    https://hub.docker.com/r/ndslabs/cloud9-base/

    		autonoMike  The devens readme is a stub
     https://hub.docker.com/r/ndslabs/cloud9-cpp/autonoMike   
     https://hub.docker.com/r/ndslabs/cloud9-go/autonoCraig   
     https://hub.docker.com/r/ndslabs/cloud9-java/autonoMike   
     https://hub.docker.com/r/ndslabs/cloud9-nodejs/autonoMike   
     https://hub.docker.com/r/ndslabs/cloud9-php/autonoCraig   
     https://hub.docker.com/r/ndslabs/novnc-base/autonoCraig   
     https://hub.docker.com/r/ndslabs/pycharm-clowder-novnc/autoclowderCraig   
     https://hub.docker.com/r/ndslabs/pycharm-clowder-xpra/autoclowderCraig   
     https://hub.docker.com/r/ndslabs/pycharm-novnc/autonoCraig   
     https://hub.docker.com/r/ndslabs/pycharm-xpra/autonoCraig   
     https://hub.docker.com/r/ndslabs/xpra-base/atonoCraig   
    ndslabs-dindhttps://hub.docker.com/r/ndslabs/dind/autobasicCraig   

    ndslabs-dspace

    		https://hub.docker.com/r/ndslabs/dspace/autono?Craig  Dockerhub didn't pick up the github readme?
    ndslabs-fedora-commonshttps://hub.docker.com/r/ndslabs/fedora-commons/autonoMike   
    ndslabs-hydrahttps://hub.docker.com/r/ndslabs/hydra/manual Craig  Incomplete service should be noted in readme
    ndslabs-iqvochttps://hub.docker.com/r/ndslabs/iqvoc/autobasicCraig   
    ndslabs-irods

    https://hub.docker.com/r/ndslabs/irods-icat/

    		autorevisitCraig  The three components share a readme – it would be worth describing the all in it.
     https://hub.docker.com/r/ndslabs/cloudbrowser/autorevisitCraig   
     https://hub.docker.com/r/ndslabs/cloudbrowser-ui/autorevisitCraig   
    ndslabs-irods-federate  okCraig  Component for iRODS
    ndslabs-jenkinshttps://hub.docker.com/r/ndslabs/jenkins/autorevisitMike  README says this is an experiment
    ndslabs-jupyterlabhttps://hub.docker.com/r/ndslabs/jupyterlab/autobasicCraig   
    ndslabs-kubernetes-contrib   All  Fork is in trouble. Need to decide what to do.
    ndslabs-nrpehttps://hub.docker.com/r/ndslabs/nagios-nrpe/autobasicCraig   
    ndslabs-orronthttps://hub.docker.com/r/ndslabs/orront/manualrevisitCraig  Incomplete service should be noted in readme
    ndslabs-owncloud

    https://hub.docker.com/r/ndslabs/postgres-owncloud/

    		manual Mike?   
     https://
    groups
    hub.
    google
    docker.com/r/
    forum
    ndslabs/
    #!forum
    owncloud/
    ndslabs
    Tutorial repo with examplesHigh
  • Update with new examples?
    • autorevisit
    Make sure old ones still work
    Mike
    Craig
      
    Readme seems to be from Developer-tutorial?
    ndslabs-pegasus   Craig
    User GuideHigh
    • Review
     
      Incomplete service should be noted in readme

    ndslabs-perf

    https://

    nationaldataservice

    hub.

    atlassian

    docker.

    net

    com/

    wiki/display/NDSC/User%27s+Guide
  • Using Docker Images 
    • Adding NDSLabs Services (this is an old draft)

    r/ndslabs/stress/

    https://

    github

    hub.docker.com/

    docker-library/official-imagesDeveloper GuideHigh
    • Finish filling out Developer Guide
    • Needs more about authoring dockerfiles / builds / etc
       

    r/ndslabs/systools/

    		manual Craig  Poorly documented artifacts from IASSIST load testing.
    ndslabs-skosmos
  • https://nationaldataservice.atlassian.net/wiki/display/NDSC/Developer%27s+Guide
    • Building Custom Docker Images
    https://
    github
    hub.docker.com/
    nds-org/developer-tutorial
    r/ndslabs/skosmos/autobasicCraig   
    ndslabs-solrhttps://
    docs
    hub.docker.com/r/
    engine
    ndslabs/
    userguide/eng-image/dockerfile_best-practices/Docker HubMedium
    solr6/autorevisitCraig  Should be renamed to solr before beta
    ndslabs-startup  okCraig
    Review Automated Builds
       
    ndslabs-sufiahttps://hub.docker.com/
    search/?isAutomated=1&isOfficial=0&page=1&pullCount=0&q=ndslabs&starCount=0
    r/ndslabs/sufia/autostubCraig  Need to add real readme
    ndslabs-system-shellhttps://hub.docker.com/r/ndslabs/system-shell/autorevisitMike   
    ndslabs-tematres
    GitHubMedium
  • Review READMEs
  • Delete unecessary repos
    • k8s-ingress
    • kubernetes
    • contrib?
    • invenio
    • data-provider
    • glopy
    • scidrive
  • Flatten out Service repos
    • Remove k8 specs
    • Move Dockerfiles to root
    • Clean-up Clowder
       
    jira
    Craig
    server
     
    JIRAserverIdb14d4ad9-eb00-3a94-88ac-a843fb6fa1ca
     Incomplete service should be noted in readme
    ndslabs-toolmanager
    keyNDS-512

    https://

    github

    hub.docker.com/

    nds-org

    r/ndslabs

    https:

    /

    /github.com/nds-org/ndslabs-specs

    toolmanager/

    		autobasicCraig   
     https://
    github
    hub.docker.com/
    nds-org/ndslabs-devenvs
    r/ndslabs/toolserver/manual Craig  Delete this?
    ndslabs-webprotegehttps://
    github
    hub.docker.com/
    nds-org
    r/ndslabs
    -deploy-toolshttps:
    /
    /github.com/nds-org/glusterIndividual Services:
    webprotege/autobasicCraig   
     https://
    github
    hub.docker.com/
    nds-org/ndslabs-dataverse
    r/ndslabs/latis/manualnoneMike?   
     https://
    github
    hub.docker.com/
    nds-org
    r/ndslabs
    -irodshttps:
    /
    /github.com/nds-org/logspout
    master/`manual ?  Mistake?
     https://
    github
    hub.docker.com/
    nds-org
    r/ndslabs
    -dspace
    /volume-vault/manual David?   
     https://
    github
    hub.docker.com/
    nds-org
    r/ndslabs
    -chisel
    /rabbitmq-server/manual ?   
     https://
    github
    hub.docker.com/
    nds-org
    r/ndslabs
    -dindhttps:
    /
    /github.com/nds-org/ndslabs-jenkins
  • etc
    • BitBucketMediumCraig to add readme with link to github
    torch/manual ?   
     https://
    opensource
    hub.
    ncsa.illinois.edu/bitbucket/projects/NDS
    docker.com/r/ndslabs/alpine/manual David?   
     https://
    bitbucket.org/nds-org/nds-labsOther Wikis?Low
    hub.docker.com/r/ndslabs/gluster-srv/manual David? 
    Archive
      
     https://
    wiki
    hub.
    ncsa.illinois.edu/display/NDS/National+Data+Service+Home
    docker.com/r/ndslabs/psi-edge/manual David? 
    Architecture DocsLowMake sure these reflect reality
      
     https://
    github
    hub.docker.com/
    nds-org
    r/ndslabs/
    tree/master/docs
    che/manual Craig?  Can likely be deleted
     https://hub.docker.com/r/ndslabs/wso2is/manual Craig  

    ...

    WSO2IS experiment, needs to be cleaned up.

    ...

    NDSC5

    DocumentPriorityNotesAssigned toReviewerStatusRelated Link(s)
    Update labsportal WordpressHigh Kenton? 
    Tutorial repo with examplesHigh MikeCraigReady for review
    Tutorial presentationHigh CraigMike/David 
    Clowder/Terra demo videoHighNeed to work with Craig to make sure titles/subtitles consistentMikeCraigReady for review
    Dataverse/iRods demo videoHigh CraigMikeAs good as it's going to be
    ndslabs-system-shell readmeHigh David  
    NDSLabs build/installation instructionsHighNeeds consolidationCraigMike 
    ndslabs repo readmeHigh

    Needs community information

    		CraigMike 
    ndslabs-specs repo readmeHighMike -> Craig: Looks good, I think?Craig/MikeMike/CraigDone
    ndslabs-clowder repo readmeHighCraig: Looks good.MikeCraigReady for review
    ndslabs-dataverse readmeHigh

    Mike -> Craig:
    Looks good

    		CraigMikeReady for review
    ndslabs-developer-shell readmeMed David  
    Best-practices for Dockerfile creationMedNeeds more best practices / consolidationMikeCraig 
    Best practices for service creationMedNeeds consolidationCraigMike 
    ndslabs-irods readmeMedMike -> Craig:
    Would it be beneficial to link to irods-federate / dataverse in 'See also'?    		CraigMikeReady for review

    ndslabs-irods-federate readme

    		MedMike -> Craig:
    A bit sparse.. may need build / run instructions if its much more complicated than 'make' or './build.sh'    		CraigMikeReady for review
    Document apiserver.confMed CraigMikeReady or review
    Dockerhub repo documentation?LowIf we have time    
    ELK demo videoLow CraigMike 
    • TBA
    Dataverse/TwoRavens demoLow CraigMike 
    • TBA
    ndslabs-deploy-tools readmeLow David  
    ndslabs-all-sources readmeLow David  
    nds-labs-legacy readmeLow