documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Implement contributor names on each guides page

Open Eric-Arellano opened this issue 1 year ago • 0 comments

Implement the design from https://www.figma.com/design/sNXucK1uMaZ8XXyLTZrdrs/IBM-Quantum-Documentation?node-id=7174-39884&t=GIeSutsuCJkUNVjg-1

Screenshot 2024-08-26 at 10 58 16 AM

Because the component is not in the footer, it should probably be a component like <ContributorsAttribution>. The other design I was considering is putting metadata at the top of the file.

How to get usernames

We need to figure out how to store the contributor GitHub usernames/handles. It will be much easier if we save the value to the file in qiskit/documentation, rather than somehow magically pulling the value at build-time in closed source. It would be hard to do the latter because it would require dynamically pulling Git information, even though the closed source and open source repos are not meant to have tight coupling.

I suspect the best approach is to have a script that dynamically adds the usernames to the file. We probably need users to manually run it, unfortunately. CI would lint to check everything is up-to-date.

Eric-Arellano avatar Aug 26 '24 15:08 Eric-Arellano