Skip to content
This repository has been archived by the owner on Aug 13, 2024. It is now read-only.

Cleanup of homepage, readme, and wiki #422

Closed
4 tasks done
kelenelee opened this issue Apr 29, 2022 · 9 comments
Closed
4 tasks done

Cleanup of homepage, readme, and wiki #422

kelenelee opened this issue Apr 29, 2022 · 9 comments
Assignees
Labels
B: Documentation ⏳ <30 hrs Size: 4 HfLA weeks or 4 traditional work days

Comments

@kelenelee
Copy link
Contributor

kelenelee commented Apr 29, 2022

Action Items

  • Deleted or combined 32 stubs to declutter wiki IA and Pages nav.
  • Uncheck Releases and Packages in the DS repo homepage sidebar.
  • Add a description to the repo sidebar

Through testing of the fork, the description cannot handle bullet lists or links. This is probably because the description populates as 1 paragraph of plain text under HfLA's list of repositories.

While we should still have some kind of description for the repo instead of it saying "No description provided," it's not clear whether something as simple as a sentence will help newcomers onboard or current members navigate and find information. Bulleted links would have been much more helpful for team members' tasks.

  • Update readme to better serve current DS team needs. Right now it takes many clicks for people to get to the Kanban board. It's possible for the beginning of the readme to have a link that goes directly there.
@kelenelee kelenelee added this to the Github heuristic evaluation milestone Apr 29, 2022
@kelenelee kelenelee self-assigned this Apr 29, 2022
@kelenelee kelenelee changed the title Revamp the wiki Re-organize and rewrite the wiki Apr 29, 2022
@kelenelee kelenelee added the ⏳ <30 hrs Size: 4 HfLA weeks or 4 traditional work days label May 5, 2022
@kelenelee kelenelee changed the title Re-organize and rewrite the wiki Wiki cleanup & rewrite May 5, 2022
@kelenelee kelenelee mentioned this issue May 5, 2022
12 tasks
@kelenelee kelenelee changed the title Wiki cleanup & rewrite Wiki cleanup May 5, 2022
@kelenelee kelenelee changed the title Wiki cleanup Wiki and readme cleanup May 21, 2022
@kelenelee kelenelee changed the title Wiki and readme cleanup Cleanup of homepage, readme, and wiki May 21, 2022
@kelenelee
Copy link
Contributor Author

@allthatyazz can we get permission to edit the repo description? I might need to experiment with the copy?...

@allthatyazz
Copy link
Contributor

@kelenelee Last time, I asked Bonnie how we can edit it, Bonnie responded that "What do you want the description to be? Put in the chat, [and] I'll edit it". So the implications for us:

  • We cannot receive the permission to edit
  • We can do experimentations elsewhere like in the Figma file or even a through a GitHub poll or something

@kelenelee
Copy link
Contributor Author

Thanks @allthatyazz. Because I forgot to document it (haha how ironic) I forgot that I forked this repo, and in the fork I can push description copy as many times as I want.

@allthatyazz
Copy link
Contributor

@kelenelee Very smart! I was thinking that you can even take the screenshots of your fork each time you change something and then use the screenshots in a poll or something if you want to collect some feedback from the team.

Also, I have a question for you. By any chance, do you have any screenshots from our original GitHub board?

@kelenelee
Copy link
Contributor Author

@allthatyazz I don't have any old screenshots... I really regret not taking a screenshot of it. I think I'll go through old meeting recordings and see if it's there

@allthatyazz
Copy link
Contributor

Try your best but if you could not get any good screenshots, then no worries at all. I guess we can use the other teams' boards as a reference too.

@kelenelee
Copy link
Contributor Author

kelenelee commented Jun 1, 2022

Hi @allthatyazz I've settled on a draft description. I don't have alternatives so I don't think I need to create a poll.

Empowering every HfLA team to create their own design system. 🛠️ 🧰 Please see our readme for more info!

  • The hammer, wrench, and toolbox emojis are meant to play on the idea of the Kit and helping other teams build.
  • I included a sentence about reading the Readme since it is very important for new people to read the directions on how to join. I'm not totally sure how to format it in the description but I settled on ` since it usually indicates file names.

If you're OK with this text, I think we can go ahead and have Bonnie paste that in. And also ask her to uncheck Releases Packages and Environments if we're not going to be using those:
Screen Shot 2022-06-01 at 6 51 39 PM

You can see a demo with the description here. Screen Shot 2022-06-01 at 6 53 31 PM

@allthatyazz
Copy link
Contributor

Bonnie has been sick and our meeting cut short. We would do this once she becomes better.

@allthatyazz
Copy link
Contributor

We completed the checklist during 11/7 Stakeholder meeting and added more tag lines. We ended up keeping the release.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
B: Documentation ⏳ <30 hrs Size: 4 HfLA weeks or 4 traditional work days
Projects
No open projects
Status: ✅ DONE ✅
Development

No branches or pull requests

3 participants