CKAN example - Githubissues

datopian / datahub

🌀 Rapidly build rich data portals using a modern frontend framework

https://datahub.io/opensource

MIT License

2.19k stars 326 forks source link

CKAN example #775

Closed luccasmmg closed 1 year ago

luccasmmg commented 1 year ago

Related to #767

Just two pages, index with list of datasets and individual page, once this gets merged im going to create the deployment and so forth.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
catalog-portal-js	❌ Failed (Inspect)			Apr 20, 2023 0:22am
dataset-frictionless-portal-js	❌ Failed (Inspect)			Apr 20, 2023 0:22am
portaljs-example	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 20, 2023 0:22am
portaljs-git-example	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 20, 2023 0:22am
site-portaljs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 20, 2023 0:22am

anuveyatsu commented 1 year ago

@luccasmmg this PR impacts 3 examples, is it expected?

luccasmmg commented 1 year ago

@luccasmmg this PR impacts 3 examples, is it expected?

In this specific case it will impact, because i changed the README on portaljs-example, and the site-portaljs example lives outside the actual monorepo structure, so its always going to get affected.

Having said that, i did forget to setup nx-ignore for portaljs-example, doing this now

anuveyatsu commented 1 year ago

@luccasmmg another question, why do we have /examples/ckan-example and /examples/ckan-example-e2e? What is end to end doing exactly?

luccasmmg commented 1 year ago

@luccasmmg another question, why do we have /examples/ckan-example and /examples/ckan-example-e2e? What is end to end doing exactly?

Those were created by the nx command that i used to initiate the projects, i havent worked on anything inside those folders, my understanding is that they give us two main advantages.

Firstly, on normal projects we usually need to initiate the app(npm run dev) and then run the tests(npm run test) while with this we can just do nx e2e simple-ckan-e2e and it loads everything necessary and does everything(much easier CI)
Secondly, i believe it gives us a way to setup the tests to only run when the affected project gets changed, which would make CI/CD stuff run easier.

We are not using those for anything in particular, but i thought best to leave them there for the future when we maybe want to add some testing and a CI/CD pipeline

anuveyatsu commented 1 year ago

@luccasmmg to be honest I'm concerned about this. It only confuses users, even for me it doesn't make sense. It should be within single directory. Now, if I look at /examples/ directory it has lots of examples but half of them aren't actual examples. Is there a way to remove them or place inside the directory?

luccasmmg commented 1 year ago

@luccasmmg to be honest I'm concerned about this. It only confuses users, even for me it doesn't make sense. It should be within single directory. Now, if I look at /examples/ directory it has lots of examples but half of them aren't actual examples. Is there a way to remove them or place inside the directory?

If you want i can delete them, no problem, its just going to be making CI/CD slightly harder, but we are not even sure if that is going to be needed

luccasmmg commented 1 year ago

@anuveyatsu removed the e2e apps

anuveyatsu commented 1 year ago

thanks @luccasmmg I just think it's not suitable for examples stuff but it could be useful for apps or packages.