[COL] website action plan

[slumnitz]

Website Materials

This is a collection of potential materials that should be integrated into the website

To-Do

• [x] set-up repo (i.e. biopal.org) containing website build/ material (Paolo, Francesco) We already have biopal.github.io as repo. Should we continue there? biopal.org repo is available
• [x] decide on "infrastructure for website" (i.e. Jackyl, Hugo, professional site developed by aresys) (Paolo, Francesco) Hugo + docsy theme
  • [x] For example components website structure: A) landing page (biopal.org repo) pointing to, B) linking to docs (.rst) content build i.e. using readthedocs (biobal/biopal/docs) C) linking to governance content jupyter book (biopal/governance).
  • [x] decide on layout, i.e. similar to dask website
  • [x] indicate content directory and preferred content format, i.e. .rst, .md for others to contribute: content/en/ -> md files

Landing page (depends on design ultimately):

• [x] High level description
  • [x] BioPAL: What is it about, goals, visions?
  • [x] linking to BIOMASS section Science
  • [ ] Quick introduction of user interface, how can it be used? (Needs clarification with @francescobanda @pmazzucchelli and @kscipal, @ClementAlbinet )
• [ ] BEST EFFORT: Try BioPAL: eg. MAAP/ Binder example
  • link to hosted notebook
• [ ] Ecosystem: Link to MAAP
  • [ ] link to MAAP platform, image MAAP landing page or CG video
  • LOW PRIORITY: potentially gallery of visualizations/ projects
  • LOW PRIORITY: Projects it is used in (MAAP)
• [ ] Background: Scientific studies/ Biomass
  • link to science section with image of slide: Algorithms it is based on
  • link to BIOMASS introduction section in Science section with one image
• [x] Institutions that support the Project
  • [x] Collect Logos (please fill list, to not forget anyone @kscipal @francescobanda ):
    • [x] Aresys
    • [x] ESA
    • [x] DLR
    • [x] Polimi
    • [x] Maciej Soja company

Getting started - describes installation and set-up of development environments

• [ ] Installation (@francescobanda - currently available material translated to .rst)
  • [ ] [BEST EFFORT] [LOW PRIORITY] Installation with conda
  • [ ] [BEST EFFORT] [LOW PRIORITY] installation with pip
  • [ ] installation with docker
  • [ ] installation from source
  • [ ] dependencies
  • [ ] trouble shooting installation
• [ ] BioPAL tutorials
  • [x] BioPAL setup
  • [ ] BioPAL setup on MAAP
• [ ] [LOW PRIORITY] link to extensive tutorials

Documentation/ Docs/ API - Usage documentation for the BioPAL software, this includes:

• [ ] API documentation, sphinx generated doc-strings i.e hosted on readthedocs
• [ ] [BEST EFFORT] High level documentation describing use cases
• [ ] [LOW PRIOTITY] changelog

Science (i.e. Resources section) - place to inform the community:

BIOMASS mission and high level description

• [x] TEXT: Biomass mission goals & intro (@kscipal )

• [x] Videos:

  • [x] NERC with Shaun
    • [x] Permission (@kscipal / Shaun)
    • [x] file/ link embedded: https://nerc.ukri.org/latest/events/impact/videos/s/
    • [x] Airbus about BIOMASS
    • [x] Permission (@kscipal )
    • [x] file/link embedded: https://www.youtube.com/watch?v=UHclzDaD36I&ab_channel=AirbusDefenceandSpace

• [x] ESA Material

  • [x] Permission ADS (@kscipal)
  • [x] biomass image

Scientific algorithms:

Idea (to be discussed):

• [ ] animated Slides/Video: 3 minute presentation or animated slides describing scientific basis of the algorithm (Maciej, Alberto, Mauro, ?)
  • [ ] AGB
  • [ ] TOMO
  • [ ] FH
  • [ ] FD
• [ ] Tutorial: 3 minute presentation or animated slides describing the code or how to get started
  • [ ] AGB
  • [ ] TOMO
  • [ ] FH
  • [ ] FD
• [ ] [BEST EFFORT] video: brief intro of BioPAL and the overall idea by Thuy and Shaun (later on)

Ecosystem

• [ ] Datasets: Description and link to datasets that can be used for development

  • [ ] Dataset metadata model, description of metadata model for datasets in use, in case someone decides to collect more data

• [ ] MAAP:

  • [ ] Video: Capgemini with Thuy
    • [ ] Permission (Stefanie/ Nuno/ Clement)
    • [ ] file/link embedded: https://nerc.ukri.org/latest/events/impact/video
  • [ ]

• Link to GEDI or NISAR missions?

Community Section:

• [ ] Get involved:

  • [ ] getting started with open source
    • [x] git setup (@slumnitz )
    • [ ] Intro on git with video (@slumnitz )
    • [x] contributing guidlines (@slumnitz )
    • [ ] Link to governance model
    • [ ] Link to MAAP forums and slack channel
    • [x] Link to code of conduct

• [ ] Get help

  • [ ] description of filing bugs, feature requests
  • [x] Link to forums (MAAP) and chat rooms (slack)
  • [x] Link to stack overflow for filing technical questions

About us section:

• [ ] Picture, github handle, contact e-mail for every developer:

  • see list biopal/governance +
  • Mauro, Alberto

• [ ] Governance material found under (biopal/governance)

  • [x] Updated material for publication (Stefanie)
  • [ ] desired format to link on website (Paolo, Francesco)

• [ ] LOW PRIORITY: License explained

• [ ] LOW PRIORITY: short history

• [ ] link to project repo

News & announcements - containing news relevant for the community, i.e.:

• [ ] Set-up
• [ ] Initial Announcements:
  • [x] New releases and updates of the software
  • [ ] Announcements of publication of papers connected to the software (Maciej paper)
  • [x] Announcements of conference talks/ workshops presenting the software project (PolinSAR)
  • [ ] [LOW PRIORITY] Announcement of data publications that can be processed with BioPAL

[slumnitz]

@pmazzucchelli @francescobanda and @kscipal this is a first outline of content for the website. Please feel free to add materials and ideas you'd like to see integrated. We can discuss ideas in the chat and edit the initial message according to changed ideas.

An important first step is to get started with setting up the "landing page repo" so we can coordinate efforts and already integrate material. I leave this in @pmazzucchelli and @francescobanda hands, I am happy to adopt the dask system and design.

[pmazzucchelli]

We already have the repo biopal.github.io in the organization. Should we use it (after making it private) to collect material for web pages? Otherwise, we should delete it and start a new one.

[slumnitz]

Hi @pmazzucchelli , is there a specific name you need the website repo to have? We already have one star on biopal.github.io :wink: If you need the namespace biopal.github.io, I would suggest to just start the development openly. This way we can also share the content with other scientists i.e. Shaun and Thuy without them having to sign up on github. Alternatively, we could start a closed development on any repo really, i.e. calling it biopal-website (if possible) and merge our final product into biopal.github.io. I would suggest we take approach nr 1.

[pmazzucchelli]

Hi @slumnitz , any repo name is ok, so we can start using biopal.github.io for collective website development. When we are ready, we will then point the website from the www.biopal.org landing page.

[kscipal]

Do we have the code of the website already on github. Then I can work on my points. Or send us the link to the website already implemented by AreSys so I see what I need to change/

Klaus

From: "Stefanie Lumnitz" @.> To: "BioPAL/biopal.org" @.> Cc: "Klaus Scipal" @.>, "Mention" @.> Date: 10/03/2021 09:54 Subject: [BioPAL/biopal.org] [COL] website action plan (#1)

Website Materials This is a collection of potential materials that should be integrated into the website To-Do set-up repo (i.e. biopal.org) containing website build/ material (Paolo, Francesco) We already have biopal.github.io as repo. Should we continue there? decide on "infrastructure for website" (i.e. Jackyl, Hugo, professional site developed by aresys) (Paolo, Francesco) For example components website structure: A) landing page (biopal.org repo) pointing to, B) linking to docs (.rst) content build i.e. using readthedocs (biobal/biopal/docs) C) linking to governance content jupyter book (biopal/governance). decide on layout, i.e. similar to dask website indicate content directory and preferred content format, i.e. .rst, .md for others to contribute Landing page (depends on design ultimately): High level description BioPAL: What is it about, goals, visions? linking to BIOMASS section Science Quick introduction of user interface, how can it be used? (Needs clarification with @francescobanda @pmazzucchelli and @kscipal, @ClementAlbinet ) BEST EFFORT: Try BioPAL: eg. MAAP/ Binder example link to hosted notebook Ecosystem: Link to MAAP link to MAAP platform, image MAAP landing page or CG video LOW PRIORITY: potentially gallery of visualizations/ projects LOW PRIORITY: Projects it is used in (MAAP) Background: Scientific studies/ Biomass link to science section with image of slide: Algorithms it is based on link to BIOMASS introduction section in Science section with one image Institutions that support the Project Collect Logos (please fill list, to not forget anyone @kscipal @francescobanda ): Aresys ESA DLR Polimi Maciej Soja company Getting started - describes installation and set-up of development environments Installation @. - currently available material translated to .rst) [BEST EFFORT] [LOW PRIORITY] Installation with conda [BEST EFFORT] [LOW PRIORITY] installation with pip installation with docker installation from source dependencies trouble shooting installation BioPAL tutorials BioPAL setup BioPAL setup on MAAP [LOW PRIORITY] link to extensive tutorials Documentation/ Docs/ API - Usage documentation for the BioPAL software, this includes: API documentation, sphinx generated doc-strings i.e hosted on readthedocs [BEST EFFORT] High level documentation describing use cases [LOW PRIOTITY] changelog Science (i.e. Resources section) - place to inform the community: BIOMASS mission and high level description TEXT: Biomass mission goals & intro @. ) Videos: NERC with Shaun Permission @. / Shaun) file/ link embedded: https://nerc.ukri.org/latest/events/impact/videos/s/ Airbus about BIOMASS Permission @. ) file/link embedded: https://www.youtube.com/watch?v=UHclzDaD36I&ab_channel=AirbusDefenceandSpace ESA Material Permission ADS @.) biomass image Scientific algorithms: Idea (to be discussed): animated Slides/Video: 3 minute presentation or animated slides describing scientific basis of the algorithm (Maciej, Alberto, Mauro, ?) AGB TOMO FH FD Tutorial: 3 minute presentation or animated slides describing the code or how to get started AGB TOMO FH FD [BEST EFFORT] video: brief intro of BioPAL and the overall idea by Thuy and Shaun (later on) Ecosystem Datasets: Description and link to datasets that can be used for development Dataset metadata model, description of metadata model for datasets in use, in case someone decides to collect more data MAAP: Video: Capgemini with Thuy Permission (Stefanie/ Nuno/ Clement) file/link embedded: https://nerc.ukri.org/latest/events/impact/video [ ] Link to GEDI or NISAR missions? Community Section: Get involved: getting started with open source git setup @. ) Intro on git with video @. ) contributing guidlines @. ) Link to governance model Link to MAAP forums and slack channel Link to code of conduct Get help description of filing bugs, feature requests Link to forums (MAAP) and chat rooms (slack) Link to stack overflow for filing technical questions About us section: Picture, github handle, contact e-mail for every developer: see list biopal/governance + Mauro, Alberto Governance material found under (biopal/governance) Updated material for publication (Stefanie) desired format to link on website (Paolo, Francesco) LOW PRIORITY: License explained LOW PRIORITY: short history link to project repo News & announcements - containing news relevant for the community, i.e.: Set-up Initial Announcements: New releases and updates of the software Announcements of publication of papers connected to the software (Maciej paper) Announcements of conference talks/ workshops presenting the software project (PolinSAR) [LOW PRIORITY] Announcement of data publications that can be processed with BioPAL ? You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.

This message is intended only for the recipient(s) named above. It may contain proprietary information and/or protected content. Any unauthorised disclosure, use, retention or dissemination is prohibited. If you have received this e-mail in error, please notify the sender immediately. ESA applies appropriate organisational measures to protect personal data, in case of data privacy queries, please contact the ESA Data Protection Officer @.***).

[pmazzucchelli]

Do we have the code of the website already on github. Then I can work on my points. Klaus, website material is in repo biopal.org (repo name equal to final landing webpage address, easier to remember). You and Stefanie are already admin of the repo

[slumnitz]

@pmazzucchelli this issue is migrated to BioPAL/biopal.org. We can now track our progress in the Biopal.org repo. I reopen this issue until all points are addressed. @kscipal you can add material directly to this repo. Let me know if we can schedule a time to add our common materials together.

[pmazzucchelli]

Another comm channel for news: twitter ?