Embedding in SharePoint

[gvee-uk]

Remember the reason for doing this is to have a consistent, single point of truth. Two mastered copies of stuff is no good to anyone!

---

I've spent some time looking at this today and I think the viable option to make this work is to have a GitHub Action that uploads the Markdown files to our SharePoint site.

These can then be linked to in SharePoint using the "File Viewer" WebPart which seems to render Markdown files sufficiently well!

Example GitHub Action to use: https://github.com/marketplace/actions/publish-to-sharepoint

Note: this needs credentials, obvs. I don't have access to create secrets in this repo, so haven't tried it.

[partially] Failed attempts include:

• Embed/iframe (GitHub doesn't allow this, and even if it did it would not be rendered markdown)
• Custom WebPart (the NPM libs and tooling for SharePoint are a massive PITA. Certainly doable but It was super frustrating and I couldn't even get their Hello World thing working properly)
• Host the Markdown from GitHub as GitHub Pages and embedding them... which in theory will work, but requires us to set that up (both in GitHub and allowing that as an allowable domain to embed). But seeing as GitHub Pages are per org/user I didn't want to go ahead and assume this would be our sole use
• Scrap the stuff on SharePoint and point people here... which is a kinda crappy idea, especially while this is not a public repo.

[KingMichaelPark]

@gvee-uk if we make the site public as a static site built off these contents this will satisfy the last point correct?

[gvee-uk]

@gvee-uk if we make the site public as a static site built off these contents this will satisfy the last point correct?

I suspect so, yup!

[gvee-uk]

@KingMichaelPark can you remind me of the public site URL, please?

🏷️ @ShedBarney

[KingMichaelPark]

https://thedatashed.github.io/eng-hb-docs/

[KingMichaelPark]

I would argue that we should add a dns entry to just have it be available at engineering.thedatashed.co.uk

[ShedBarney]

to have a consistent, single point of truth. Two mastered copies of stuff is no good to anyone!

Regarding this, I've spotted that there's some content on Sharepoint which doesn't seem to be in the handbook but might still be pertinent:

• The engineering principles
• The capacity management process page
• The time sheets explained page
• The shed data services page
• The working with clients page
• The engineering reviews page
• Tech Ops
• The team list

I'm not entirely sure which, if any, of the above is still in use and/or can be considered relevant enough to be included in the handbook repo. I'd be happy to migrate across if so.

[KingMichaelPark]

Principles : yes
Capacity management: Very much out of date, no
time sheets: no
data services: no
clients: no
engineering reviews: out of date, we don't use that anymore
tech ops: no
team list: probably not

[ShedBarney]

Fantastic, I've knocked up the principles in markdown and can open a PR with the addition.

[KingMichaelPark]

Cheers feel free to whenever convenient