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

Create proposal to revamp/redesign the docs home page #2070

Closed
5 of 6 tasks
akeller opened this issue May 4, 2023 · 10 comments
Closed
5 of 6 tasks

Create proposal to revamp/redesign the docs home page #2070

akeller opened this issue May 4, 2023 · 10 comments
Assignees
Labels
component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team

Comments

@akeller
Copy link
Member

akeller commented May 4, 2023

Overview

Our homepage serves 3 broad purposes, as defined by three content sections:

  • Get Started/Sign Up
  • Defining our docs top nav structure
  • Linking to our three getting started use cases

This is great for beginners and folks new to Camunda, but may not be the best fit for our maturing platform and user base.

We should come up with a set of proposals and solicit feedback on how to best use this page for all users, beginners to advanced, pro-code and low-code.

To do

  • Collect feedback (completed by April 26)
  • Research other docs landing pages (completed by April 26)
  • Draft up proposals (completed by April 26)
  • Submit proposals for feedback (completed by April 26)
  • Address feedback, determine draft changes (completed by May 3)
  • Draft changes in PR (completed by May 27)
@akeller akeller added component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team labels May 4, 2023
@akeller akeller moved this to 🆕 Inbox in Developer Experience May 4, 2023
@christinaausley christinaausley self-assigned this Feb 27, 2024
@christinaausley christinaausley moved this from 🆕 Inbox to 📋 Backlog in Developer Experience Feb 27, 2024
@akeller
Copy link
Member Author

akeller commented Mar 7, 2024

I reaaaally like this as a project for you!

I'd love to see a proposal on what content we should have on our homepage based on how things have changed since we launched! Do we add more explanation for what Camunda is? Do we add a brief intro for Self Managed? Can we figure out a way to highlight new things in docs?

You can also research other docs sites to see what they do on their main pages to draw inspiration. Part research, part proposal!

@christinaausley christinaausley moved this from 📋 Backlog to 🏗 In Progress in Developer Experience Apr 23, 2024
@christinaausley
Copy link
Contributor

christinaausley commented Apr 23, 2024

Survey in progress, circulated among the onboarding team and DevRel as well. Digging through related sites for inspo and drafting up notes currently.

Updated description with timeline of tasks 👍

@christinaausley
Copy link
Contributor

Proposal and feedback are collected at https://docs.google.com/document/d/1IWpDWiaavNVMgKcUUbD3h3ru6mWOAwLgCpXyudlU6A4/edit?usp=sharing 👍

@christinaausley christinaausley moved this from 🏗 In Progress to 👀 In Review in Developer Experience Apr 29, 2024
@akeller
Copy link
Member Author

akeller commented May 6, 2024

@christinaausley This looks amazing! Let me gush a little more:

  • I love that you used an internal survey mechanism to collect feedback
  • I love that you included that in your proposal doc and tried to accommodate all of it
  • I love that you included a mix of things are are easily achievable and static as well as some areas that need a little more thought and development (proposals don't need to be 100% and we should expect to adjust them)

1 challenge for you - if you need to deliver this incrementally, what would you address first? How would you iterate?

@christinaausley christinaausley moved this from 👀 In Review to 🏗 In Progress in Developer Experience May 9, 2024
@christinaausley
Copy link
Contributor

christinaausley commented May 14, 2024

I have a pretty good draft going in #3792, and honestly we could likely merge this in if approved. I'd just need to revert the footer, as that is still a WIP.

FYI that I've submitted a marketing ticket for custom top and bottom banners 👍

Still to do IMO:

  • Are features the only way we can outline the cards here? Can I add a div around each one to apply a background, and round the corners?
  • Essentially, how can I make these little icon cards look cool? Should the icons themselves be orange? Alternating orange and black?
  • Should we apply a video to the footer, rather than an image or a code snippet? What if there isn't any video content available? If there is, is it maintainable?
  • I don't love the way the footer looks at all right now (so for anyone following this please ignore!!) -- need to figure out how camunda.com applies a cool "feature" box, and how I could apply this, too.
  • Does the design team want to create a custom background for the header and/or footer?
  • As a user scrolls down the page, can I have the icons gradually fade/slide/transition in? How do I make them hover on mouse hover like the original version?

Planning to tackle three of these boxes each week, with plans for this to be ready for final review in two weeks/before the end of the month.

@christinaausley
Copy link
Contributor

To meet with @karl-heinsen next week to polish up some of the design and CSS, as well as collect Karl's overall feedback 👍

@melanie-butcher
Copy link

@christinaausley - I will add Philippa as a designer to work with you on this project. Welcome to the team, @PhilippaC22 !

@christinaausley
Copy link
Contributor

Thank you @melanie-butcher and welcome @PhilippaC22! Excited to work together.

Planning to get the first iteration cleaned up this week so I have a clean slate to work with @PhilippaC22. I just need to get the cards to align, and clean up a few nit picky things.

@PhilippaC22 and I can work together on the next iteration, which I can start looking at next week 👍 Could be interesting to loop in a UX researcher as well. Karl pointed me to @lmbateman, but will touch base with @PhilippaC22 first!

Still waiting to hear back from marketing on a custom banner for the header and footer, but the request is out there regardless.

@christinaausley
Copy link
Contributor

I have things in a place where I think we can merge a first iteration and start with a clean slate. I feel like the current PR goes beyond the scope of this issue anyways, as we made changes beyond just launching a proposal and soliciting feedback.

I realize we may want to re-evaluate the landing page based on SaaS/SM feedback, so I propose an issue for a second iteration, where I can also work with @PhilippaC22 (new designer), and will also have custom templates for the top and bottom banners from marketing CC Grant Eaton.

Thoughts? If we feel the first iteration is a sufficient improvement to close this out, I'll get another issue launched for a second iteration, or SM/SaaS-specific revamp.

@christinaausley
Copy link
Contributor

Second iteration to come with https://github.com/camunda/developer-experience/issues/340.

@github-project-automation github-project-automation bot moved this from 🏗 In Progress to ✅ Done in Developer Experience Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content dx Documentation infrastructure typically handled by the Camunda DX team
Projects
Archived in project
Development

No branches or pull requests

4 participants