Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implementation Dashboard - Going Public #169

Closed
8 tasks done
laurentsenta opened this issue Sep 19, 2023 · 6 comments
Closed
8 tasks done

Implementation Dashboard - Going Public #169

laurentsenta opened this issue Sep 19, 2023 · 6 comments
Assignees

Comments

@laurentsenta
Copy link
Contributor

laurentsenta commented Sep 19, 2023

Contributes to #123
See comment in #152 (comment)

Get our domain name | 1 day

  • Decide and deploy to our production's domain name

Update documentation | 1 day

  • Document how to add a new implementation to the dashboard
  • Document the generation flow
  • Link to the dashboard from this repo's README

surface job URL better and render details | 1 day

  • what commit of the conformance test suite we ran
  • what commit of the implementation we ran against
  • date when these results are from

Link to this dashboard | 1 day

Make future development simpler | 1 day

  • Add a temporary preview deploy URL in PR to test the dashboard (with a triggered job?)
@laurentsenta
Copy link
Contributor Author

@lidel @BigLep who should be involved with deciding on the domain name for the dashboard?

We talked about using gateway conformance to test other ipfs specs, like unixfs, etc. So I would propose https://conformance.ipfs.tech

@laurentsenta laurentsenta self-assigned this Sep 19, 2023
@laurentsenta laurentsenta mentioned this issue Sep 19, 2023
7 tasks
@lidel
Copy link
Member

lidel commented Oct 2, 2023

conformance.ipfs.tech or even conformance-tests.ipfs.tech sgtm.

@laurentsenta @BigLep Just an idea, but since we want to leverage this for testing things beyond gateway semantics,
thoughts on short and straight to the point test.ipfs.tech? I'm ok either way.

ps. before going live, we should to improve the landing page a bit: make it more informative, and link to other test suites that exist (i think we have stuff in https://github.com/ipld/codec-fixtures/, https://blog.libp2p.io/multidim-interop/ etc), so test.ipfs.tech acts as one-time-stop for discovering conformance test suites beyond gateway-conformance too).

@BigLep
Copy link

BigLep commented Oct 2, 2023

I like the idea of being able to go to a landing page to learn about "IPFS testing". That said, that is a broader topic as ideally cover (implementation) unit testing, (implementation) integration testing, (multiple implementation) conformance testing. It would seem a bit odd for https://github.com/ipfs/gateway-conformance to be the place pointing to implementation testing topics. As a result, maybe conformance.ipfs.tech to be clear about the slice of testing we're focused on here? (Separately and out of scope here there could be a docs.ipfs.tech page that discusses how testing is done in IPFS, which is just links to implementation pages and conformance.ipfs.tech)?

I'm good with what you decide here. I just want to make sure we don't name squat on a broad topic like "testing" if that isn't something we plan to fully cover here.

Agreed though that expanding the landing page is good/right to do covering things like:

  • Why
  • How
  • Related Projects

@BigLep
Copy link

BigLep commented Nov 6, 2023

@laurentsenta : just checking in on the status here. Do we have an estimate on when this will land?

@laurentsenta
Copy link
Contributor Author

@BigLep thanks for the status check; I'd like to get the dashboard released this week so we can review the copy next week.

infra PR: is in https://github.com/protocol/infra/pull/1299
fleek deploy PR: #177

fwiw, thanks to @lidel feedback, we aligned with the specs, it looks like this now:

CleanShot 2023-11-07 at 13 34 06@2x

@lidel
Copy link
Member

lidel commented Nov 20, 2023

Had sync with @laurentsenta today, and I believe we got everything we needed from IPDX for MVP before nucleations. Marking this as closed, thank you!

If there are missing features, we will triage and plan after IPDX nucleation activities are done

Remaining work is in Stewards size of court, tracked in ipfs/specs#456

@lidel lidel closed this as completed Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants