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

Reorganise contributor JSON file #2246

Closed
tunetheweb opened this issue Jun 14, 2021 · 4 comments
Closed

Reorganise contributor JSON file #2246

tunetheweb opened this issue Jun 14, 2021 · 4 comments
Assignees
Labels
development Building the Almanac tech stack good first issue Good for newcomers
Milestone

Comments

@tunetheweb
Copy link
Member

tunetheweb commented Jun 14, 2021

At the moment we have a contributors section in each year's JSON file (2019.json, 2020.json, and 2021.json).

Should we merge these into a contributors.json to avoid duplication? We could then have a contributions section for each profile. So for example mine might be:

    "tunetheweb": {
      "name": "Barry Pollard",
      "avatar_url": "https://avatars3.githubusercontent.com/u/10931297?v=4&s=200",
      "website": "https://www.tunetheweb.com",
      "github": "tunetheweb",
      "linkedin": "tunetheweb",
      "twitter": "tunetheweb",
      "contributions": {
        "2019": [
          "brainstormers",
          "authors",
          "reviewers",
          "editors",
          "developers"
        ],
        "2020": [
          "analysts",
          "authors",
          "developers",
          "editors",
          "leads",
          "reviewers"
        ],
        "2021": [
          "developers",
          "leads"
        ]
      }
    },

Might also want to note the chapters contributed to in each year but above would be a start to give what we have.

Some things to consider:

  • We have a contributors page for each year that should only show that years contributors and the total number of contributors for that year.
  • the npm run generate script has some checks to ensure we don't have someone down as an author, analyst...etc. unless they are also down for that role in one of the chapters meta data so it would need to be updated too.

This would require a bit of Python, Jinja and JavaScript knowledge but happy to work with someone to help them if they are not used to our tech stack.

@tunetheweb tunetheweb added good first issue Good for newcomers development Building the Almanac tech stack labels Jun 14, 2021
@tunetheweb tunetheweb added this to the 2021 Launch 🚀 milestone Jun 14, 2021
@tunetheweb
Copy link
Member Author

This could help with #1195 and is probably a necessary first step towards that.

@Shaleen-25
Copy link

Hey, @tunetheweb , I am interested in working on this issue, can you please assign this issue to me.

@tunetheweb
Copy link
Member Author

Done! Let me know if you have any questions on need to bounce ideas or approach off of someone.

@tunetheweb
Copy link
Member Author

Closed with #3399

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Building the Almanac tech stack good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants