search

NASA-IMPACT / nasa-apt

Code and issues relevant to the NASA APT project
Apache License 2.0
5 stars 0 forks source link

Adding PDF versions of Historical ATBDs to the repository #884

Open bwbaker1 opened 1 month ago

bwbaker1 commented 1 month ago

Description

The NASA Earth Observing System (EOS) science project website is migrating to the NASA Science Mission Directorate. The EOS team plans to migrate their historical ATBDs to APT, totaling over 100 historical ATBDs.

We intend to treat these as external ATBD templates, uploading each individual PDF and including available metadata (likely just ATBD identifying information and science keywords). I have the following questions:

  1. Does it make sense to structure the repository into two directories - one for standardized ATBDs created with APT and one for historical ATBDs (see diagram)?

Image

  1. The search functionality can simultaneously query both the Standardized_ATBDs and Historical_ATBDs directories, returning comprehensive results from across all available ATBD documents. Will this require a complicated solution?

  2. What is the estimated LOE and amount of time to complete both 1 and 2?

This is not finalized yet, but IMPACT management has asked me to draft a plan outlining the estimated LOE, team resources, and the likely duration for both updating the repository and for the team to upload all the PDFs.

bwbaker1 commented 1 month ago

@sunu @kamicut Will one or both please respond to these questions? I just need general answers at this point to include in the write-up.

Also, feel free to propose a better solution.

kamicut commented 1 month ago

Hey @bwbaker1, this design seems sensible to me. Will inputting the historical ATBD be a manual process (individually, one atbd at a time) or a batch process where we process the PDFs and metadata files in one go? I don't see an issue with search or uploading since it's a small amount of historical ATBDs.

bwbaker1 commented 1 month ago

Thanks @kamicut! Unfortunately, this will be a manual process to add individual PDFs.

Will you provide me an estimate how many sprints it would take to make these changes to the repository? Also, how many people from DevSeed would be needed for this?

wrynearson commented 1 month ago
  1. I think that's more of a question for you, from the discoverability aspect of ATBDs. If the focus is "here are all the ATBDs", then it wouldn't make sense to separate them. But if users want to see only "standard" ATBDs, then it could. I'd think users wouldn't need to make this distinction, but I could be wrong.
  2. This is simple if we keep the current upload ATBD format, because we search on the supplemental info (summary, title).

If we do need to distinguish ATBDs based on their structure (instead of their format), we can add a checkbox in the ATBD upload process to indicate that it's an historical ATBD not based on a template, or indicate that it's from a template. We already have the design & language for this, because we say "Upload existing ATBD PDF" in the create ATBD workflow.

image

If we add a checkbox/dropdown to flag the difference between historical and template-based uploads, it will take us about 1 sprint. If we need to re-think how we visually separate these, then it will take more sprints.

bwbaker1 commented 1 month ago

@wrynearson Ok, I will pitch both ideas when I send the documentation to Rahul.