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

Website redesign, branding, and long term structure #978

Closed
10 tasks
thescientist13 opened this issue Sep 8, 2022 Discussed in #503 · 4 comments · Fixed by #1094 or #1297
Closed
10 tasks

Website redesign, branding, and long term structure #978

thescientist13 opened this issue Sep 8, 2022 Discussed in #503 · 4 comments · Fixed by #1094 or #1297
Assignees
Labels
content RFC Proposal and changes to workflows, architecture, APIs, etc v0.30.0 website Tasks related to the projects website / documentation
Milestone

Comments

@thescientist13
Copy link
Member

thescientist13 commented Sep 8, 2022

Discussed in #503

Originally posted by thescientist13 April 3, 2021
As we plan for the next set of features to get Greenwood to a 1.0 release it would be to start discussing some related issues around structure, navigation, discoverability, and design.

Some previous related issues on this topic were

Some things we would like to consider are:

  1. Tell a better story on the home page, with code snippets of newer features like SSR / hybrid rendering, API routes, Adapters, etc (from zero to hero as it were). Including a showcase here would be nice
  2. Re-org of docs - too many clicks to get around, sections like Frontmatter and Markdown could probably be consolidated
  3. Rebrand / theme the whole website (new logo at least)
  4. Start tracking deprecations providing more idiomatic choices / duplication of overlapping concepts
  5. I think its time to decouple the website from the monorepo. This would also let us re-evaluate our release branching / merging strategy, since commits wouldn't be tied to automatic documentation deployment.

Details

These are the things we should do as part of the actual cutover

  1. Location redirects for new website - content/issue 33 guides pages www.greenwoodjs.dev#94 + content/issue 31 Docs pages www.greenwoodjs.dev#117
    • /guides/cloudflare-workers-deployment/ -> /guides/hosting/cloudflare/
    • /guides/firebase/ -> 404
    • /guides/github-pages/ -> /guides/hosting/github/
    • /guides/netlify-deploy/ (netlify) -> /guides/hosting/netlify/
    • /guides/netlify-cms/ (netlify???) -> 404
    • /guides/now/ (vercel) -> /guides/hosting/vercel/
    • /guides/s3-cloudfront/ (AWS) -> /guides/hosting/aws/
    • /guides/theme-packs/ -> /guides/tutorials/theme-packs/
    • /getting-started/ -> /guides/getting-started/
    • /about/* -> /docs/introduction/about/
    • /plugins/ -> /docs/references/plugins-api/
    • /plugins/adapter/ -> /docs/reference/plugins-api/#adapter
    • /plugins/context/ -> /docs/reference/plugins-api/#context
    • /plugins/copy/ -> /docs/reference/plugins-api/#copy
    • /plugins/renderer/ -> /docs/reference/plugins-api/#renderer
    • /plugins/resource/ -> /docs/reference/plugins-api/#resource
    • /plugins/rollup/ -> /docs/reference/plugins-api/#rollup
    • /plugins/server/ -> /docs/reference/plugins-api/#server
    • /plugins/source/ -> /docs/reference/plugins-api/#source
    • /plugins/custom-plugins/ -> /docs/plugins/
    • /docs/component-model/ -> /docs/introduction/web-standards/#web-components
    • /docs/configuration/ -> /docs/reference/configuration/
    • /docs/front-matter/ -> /docs/resources/markdown/
    • /docs/markdown/ -> /docs/resources/markdown/#frontmatter
    • /docs/scripts/ -> /docs/resources/scripts/
    • /docs/css-and-images/ -> /docs/resources/styles/
    • /docs/layouts/ -> /docs/pages/layouts/
    • /docs/server-rendering/ -> /docs/pages/server-rendering/
    • /docs/api-routes/ -> /docs/pages/api-routes/
    • /docs/menus/ -> /docs/content-as-data/collections/
    • /docs/data/ -> /docs/content-as-data/
  2. Refresh README.md
  3. Refresh GitHub Actions
  4. Refresh CONTRIBUTING.md
  5. Review any open Greenwood issues / discussions and see if they should be updated / closed / etc
  6. Getting Started

These are the things to track after the cutover

  1. Workspace changes
  2. consider introducing conventional commits
  3. Adopt npm (workspaces) over Yarn
  4. Upgrade / refine usage of Lerna (as per its its recent versions)
    • can we finally fix the peerDependencies error for npm (by bumping peer deps in our packages on each release?)
@thescientist13 thescientist13 added website Tasks related to the projects website / documentation content labels Sep 8, 2022
@thescientist13 thescientist13 added this to the 1.0 milestone Sep 8, 2022
@thescientist13 thescientist13 added the RFC Proposal and changes to workflows, architecture, APIs, etc label Oct 2, 2022
@thescientist13
Copy link
Member Author

Should probably consider E2E testing (finally) when considering going out with our "final" docs. - #560

@thescientist13
Copy link
Member Author

thescientist13 commented Apr 13, 2023

After reviewing the initial design for the #1094 , some good discussions around rethinking parts of the website came up

  1. Consider making more space on the home page by moving the new Greenwood logo banner up into the corner
  2. We should brainstorm what elements we want on the home page and what kind of users we want to make sure to connect with
    • those just looking to see what a repo looks like
    • those wanting to jump right to stackblitz (see the above) or some sort of quick(er) getting started
  3. As they say in movies, show don't tell. Perhaps a snazzy code snippet of some web standards focused code, like custom elements as pages?
  4. We could / should consider updating the "features" boxes and README since a lot of work and new features have been added since those were originally authored.

One good exercise we considered was doing a live mockup with all the elements we want, and just drag and drop them in real time. We can use it as forcing function to really understand what we care about most in terms of showing off and what to prioritize. All these items are important, unfortunately they can't all be above the fold, so we'll have to pick something, and ideally that also works well on mobile to make sure we retain the "above the fold" experience.

@thescientist13
Copy link
Member Author

For anyone following along, please feel free to get involved in some discussions i've started for the new website. ✌️

@thescientist13
Copy link
Member Author

thescientist13 commented Oct 28, 2024

Release / Launch Runbook

1) v0.30.0 Release - by 11/2

  1. v0.30.0-alpha.8 release - https://github.com/ProjectEvergreen/greenwood/issues?q=label%3Av0.30.0+label%3Aalpha.8
  2. v0.30.0 GA - release/0.30.0 #1208
  3. publish blog post with final date - content/issue 103 v0.30.0 release blog post www.greenwoodjs.dev#118

2) Pre-Launch - by 11/4

  1. PRs for all Urgent priority website issues - https://github.com/orgs/ProjectEvergreen/projects/4/views/2?filterQuery=-status%3A%22%E2%9C%85+Done%22++milestone%3A%22Website+Redesign+and+Relaunch%22
  2. Open PR for monorepo website cutover (no merge!) - - Website redesign, branding, and long term structure #978
  3. Open Ecosystem PRs for new website links

3) Launch - 11/6

  1. all Urgent website PRs reviewed / completed - https://github.com/orgs/ProjectEvergreen/projects/4/views/2?filterQuery=-status%3A%22%E2%9C%85+Done%22++milestone%3A%22Website+Redesign+and+Relaunch%22
  2. setup netlify analytics for new site
  3. DNS <> Netlify cutover (activate www.greenwoodjs.dev)

4) Post Launch - 11/8

  1. Ecosystem PR merges
  2. v0.30.1 PR merges and release
  3. enhancement/getting started guide refresh greenwood-getting-started#88
  4. refresh / close / whatever demo getting started PRs - https://github.com/ProjectEvergreen/greenwood-getting-started/pulls?q=is%3Apr+is%3Aopen+label%3Aexample
  5. Update Greenwood repo settings
  6. Turn discord server into a community server

@thescientist13 thescientist13 linked a pull request Nov 8, 2024 that will close this issue
1 task
@thescientist13 thescientist13 reopened this Nov 8, 2024
@thescientist13 thescientist13 moved this from ✅ Done to 👀 In review in [Greenwood] Phase 9 - Standards and Conventions Nov 8, 2024
@thescientist13 thescientist13 unpinned this issue Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content RFC Proposal and changes to workflows, architecture, APIs, etc v0.30.0 website Tasks related to the projects website / documentation
Projects
No open projects
1 participant