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

Set up the Vuepress website system #416

Closed
42 of 45 tasks
monikappv opened this issue Jan 27, 2020 · 1 comment
Closed
42 of 45 tasks

Set up the Vuepress website system #416

monikappv opened this issue Jan 27, 2020 · 1 comment
Assignees

Comments

@monikappv
Copy link
Member

monikappv commented Jan 27, 2020

Implement everything we need technically in the new vuepress-based setup ...

Probably want at least one example page for each major section working and crudely laid out ...

Acceptance

Booted website with at least one example page for each major section:

  • Basic vuepress based site
  • built automatically with github actions
  • Some core pages skeletonned
  • How to do theming + templating incl multiple pages off one layout (based on a template)
  • It's communicating to Google Analytics

Pages

  • Home page
  • News / Blog
  • Team
  • Jobs to be Done
  • Products
  • About (VueJS does not have about page - do we need one ...?)
  • Documentation (later when clear what we need)

Tasks

  • Install vuepress and have it run
    • Choose whether we build from root or a subdirectory like site From the root
    • Stub standard vuepress front page
  • Implement github actions to build
  • Add README.md CONTRIBUTING.md explaining how to contribute
  • Install vuepress plugins we may want e.g. footnotes, mermaid (copy from datopian handbook)
  • stub content for each page with the structure of you will want
    • job to be done page /jobs/pull-data/ @Irio
    • product page e.g. /products/data-packages/ @Irio
    • about @monika
    • blog (have this from migration content)
  • Research how to do theming and have "layout" pages i.e. a whole section using the same template and for those bespoke templates to still have core theme elements See this extensive summary https://hackmd.io/@rufuspollock/BJ318ubfU
    • Try it out
    • Work out how we do template inheritance / core
  • Blog experiment - may require some research on plugin. See below for tasks.
  • Team page Done. See http://next.frictionlessdata.io/team/
  • Check we can embed html in markdown pages as we need some HTML pages Yes we can - see below
  • Configure Google Analytics with the VuePress plugin

Theming

Which pages need a different layout than the default one?

  • Default page: like a doc page / like vuepress default
  • Home page
  • Blog listing
  • Product / Job pages

Do we want to use vuepress' default layout for all pages (a little bit customized) except for the home page?

Is it more that we have reusable components / snippets of some kind? e.g. hero section etc etc.

Let's not try and work out too much in advance => KISS

Tasks

  • Boot the theme
    • Do we extend default theme or roll our own? KISS: start with it and see where it breaks ...
      • Default theme is nice esp for docs ...
      • But is there a way to extend? => Yes, via inheritance
      • And does it do enough? Maybe not but we can extend
  • Create a layout file
  • Customize home
  • Apply it to a page http://next.frictionlessdata.io/products/data-package/

Learnings

  • You can inherit from the base theme
  • But you will need to refactor Layout.vue or override probably ultimately ...
    • Refactor into GlobalLayout? No.

Blog experiment

Outcome

  • Individual blog page
  • Blog index page
  • Notes on how to do it (not really needed, docs are actually quite clear)

Tasks

Team Page

Goal a page looking like https://vuejs.org/v2/guide/team.html (but w/o styling atm)

Source is https://raw.githubusercontent.com/vuejs/vuejs.org/master/src/v2/guide/team.md

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

No branches or pull requests

3 participants