GSA / ai-experience-sharing-platform

This is the source code for the CoE AI Platform (Use Case Library and other content).
Other
11 stars 2 forks source link

SPIKE: Research & Design a way to fit the AI Site into the COE AI page #402

Open sstatz opened 3 years ago

sstatz commented 3 years ago

COE Site Page: https://coe.gsa.gov/coe/artificial-intelligence.html Make a proposal for how to fit the new AI Site here. Run it by Danielle Gallant.
Set your hour limit ahead of time for this proposal.

As a team member, in order to get approval for how the AI guide for government content can fit into the COE AI page, I want to come up with a design and run it by Danielle Gallant & write stories to do the work.

sknep commented 3 years ago

This is a pretty straightforward Jekyll site.

Currently the page is a single markdown file with some yaml here: https://github.com/GSA/centers-of-excellence/blob/master/coe/artificial-intelligence.html

At one time, the AI COE had(?) it's own html layout (although it currently uses the default COE layout): https://github.com/GSA/centers-of-excellence/blob/master/_layouts/coe-ai.html so there's some precedence for AI being 'a little bit extra', though why it's not used now, I couldn't say.

It uses some data files to fill out a nav: https://github.com/GSA/centers-of-excellence/blob/master/_data/coe.yml#L17 which our proposed content won't fit nicely within.

The repo also has a few separate, unlisted, one-page experiences at https://coe.gsa.gov/coe/farm-loans/ and others, which use the site header and footer but page contents custom to the feature. We could put the proposed new AI site content in something like this easily, but the discoverability is the big thing here.

sknep commented 3 years ago

Using the existing Jekyll site and patterns, we should be able to work on a new template with an integrated side-nav that uses USWDS v1 and a new Jekyll Collection for the AI Site content formerly known as the body of knowledge. I pulled an existing template from the repo and put together this example in code locally this morning: screencapture-127-0-0-1-4000-coe-ai-guide-for-government-module1-3-2021-06-01-14_36_33

I'd still like to add prev/next links at the bottom of the page but that's trivial.

I wanted to see if the urls (currently things like '/module-3-1') were an artifact of the CMS integration or an intentional choice. We could pull the ordering from the filename itself, but for now I chose to use the existing metadata present on the docs in a bok_section_id field in YAML.

Once we have the content in this jekyll site, we'd still need to figure out discoverability. There's space for a link in the sidebar of the COE AI page. These other mini-experiences have the same problem — they exist at known urls but aren't linked to from the larger site nav (they are referred to from blog posts, but they're still basically unlisted). That could be ok, if we know that folks will be able to find these from other places.

@jonadecker thoughts?

jonadecker commented 3 years ago

💯

sknep commented 3 years ago

Still need to accommodate: