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

Turn this repo into core template and move core lib to portaljs repo #509

Closed
19 of 22 tasks
rufuspollock opened this issue May 26, 2023 · 2 comments · Fixed by #513
Closed
19 of 22 tasks

Turn this repo into core template and move core lib to portaljs repo #509

rufuspollock opened this issue May 26, 2023 · 2 comments · Fixed by #513
Assignees

Comments

@rufuspollock
Copy link
Member

rufuspollock commented May 26, 2023

Why: turning this into the simple template (and having core lib) elsewhere makes it simpler for users who just have one obvious repo to use or clone.

Why move core lib: because core lib is used in portaljs and has a lot of overlap. Given overlap easier to maintain in one place.

Acceptance

  • Move all the core Flowershow code into github.com/datopian/portaljs 🚧2023-06-06 in Integrate flowershow packages datahub#923
  • Turn github.com/datopian/flowershow into the template people can "just use" i.e. the template
    • This template uses the core library now in portaljs

Tasks

  • Remove CLI => just use obsidian plugin or use the template 🔥
    • install: will just clone or fork this repo
    • What about preview in future? people using preview can just clone and use nextjs tooling
  • packages to portaljs
    • core package => move over wholesale
    • remark stuff all moves across no problem
    • cli removed (see above)
    • markdowndb => delete 🔥
    • Need to publish under the new scope
  • examples: remove as out of date
    • check if any blogs refer to these and remove references
  • e2e tests: move to portaljs
    • Investigate if that can work easily the easiest thing I can think of is adding the template as a submodule, but probably can be solved without it; for now just moved it to datopian/flowershow-template-e2e, will adjust later
  • Move flowershow-template to root of flowershow
    • Deprecate flowershow-template i.e. add notice
    • Update references in other places
    • Make flowershow into a github template

Questions

  • What about changesets changelog? ✅2023-06-06 lose them because will break in new location? and we've already removed. Basic rule: do the simplest thing possible.
  • What about package versions? I thought the best option is to even them all out to 1.0.0, create git tags with this version for each new package, and start from there, since we're going to publish under the new scope and there won't be corresponding tags in portal js repo so it makes no sense to keep the original onces
@rufuspollock
Copy link
Member Author

@olayway estimates 2-4h left! (Did a bunch yesterday)

@rufuspollock
Copy link
Member Author

FIXED. Summary:

  • all the flowershow packages moved to portaljs repo, published under @portaljs scope, and @flowershow ones are deprecated
  • @flowershow/markdowndb package deprecated and now published under mddb
  • flowershow template, portaljs site, portaljs example projects and markdowndb examples updated to account for the above changes
  • datopian/flowershow repo is now the template repo
    • datopian/flowershow-template is archived
    • obsidian-flowershow and the CLI updated accordingly
  • datopian/flowershow-cli created for now as I have no idea how much time it will take to get the obsidian plugin pubished and people seem to be using it and e.g. had to update path to the current template repo 💬2023-06-16 why do we need the cli anymore? - don't you just fork the template? ⏭️ Create dedicated issue to analyse and implement
  • E2E tests setup in datopian/flowershow-template-e2e - can be run locally and are also run in the Flowershow template's CI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants