alphagov / alphagov/data-community-tech-docs

Missing content in Knowledge Graph docs

Open
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
7
Forks
4
Avg merge
13h 45m
Merged PRs (30d)
19

Description

I feel like something is missing here.

Could we add what Labels and Relationships are built using these intermediate files? We are not saying anything about how the knowledge graph is actually built, i.e., how all these bits and pieces come together.
Like, what happen in the provision_knowledge_graph? What nodes and relationships are created exactly? We need this info here. cc: @maxf

We are also missing information about eligibility_pages and external_links intermediate files which are also created as part of building the graph data.

Can we also add an image/screenshot of the knowledge graph?

Originally posted by @exfalsoquodlibet in https://github.com/alphagov/data-community-tech-docs/pull/13#discussion_r772454300

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation for provision_knowledge_graph and how the eligibility_pages and external_links intermediate files are described. Document how Labels and Relationships are built, which nodes and relationships are created, and how the intermediate files fit together. Add a knowledge graph image or screenshot, with the documentation complete when these details and the image are included.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.