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

[Feature Request] Present authors of pages automatically in Aptos.dev #5808

Closed
clay-aptos opened this issue Dec 7, 2022 · 12 comments · Fixed by #5942, #6076 or #6101
Closed

[Feature Request] Present authors of pages automatically in Aptos.dev #5808

clay-aptos opened this issue Dec 7, 2022 · 12 comments · Fixed by #5942, #6076 or #6101
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request P1 Priority 1 Stale

Comments

@clay-aptos
Copy link
Contributor

🚀 Feature Request

@davidiw was just asking me for a mapping of contents to owners, and I pointed out I have already asked for an Authors list at the bottom of every page on Aptos.dev.

Motivation

This would provide that mapping while giving an incentive to external and internal contributors both to maintain and enhance the docs.

Pitch

Our competitors are already doing it and getting more external contributions as a result:
https://docs.sui.io/devnet/learn

This would go a long way toward establishing co-ownership of these materials rather than them being owned by everyone and no one at once.

Additional context

@moonclavedev and I spoke about this already. I simply need some tracking mechanism to ping from time to time until the feature is complete. :-)

@clay-aptos clay-aptos added the enhancement New feature or request label Dec 7, 2022
@clay-aptos clay-aptos added documentation Improvements or additions to documentation P1 Priority 1 labels Dec 7, 2022
@zacharydenton
Copy link
Contributor

Thanks for the reminder, Clay. #5827 adds the list of contributors.

@davidiw davidiw closed this as completed Dec 11, 2022
@clay-aptos
Copy link
Contributor Author

Thank you, @zacharydenton! May I ask when we will see this on Aptos.dev? For example, on the bottom of:
https://aptos.dev/concepts/accounts/

@clay-aptos clay-aptos reopened this Dec 12, 2022
@clay-aptos
Copy link
Contributor Author

I'm going to reopen for us to test this out.

@zacharydenton
Copy link
Contributor

It's possible that the process for generating the list of authors doesn't work when we're building for Netlify (it won't work for example if Netlify does a shallow clone instead of retrieving the full git history). If that's the case, we can adjust the build process so that we manually generate a JSON file of the authors locally, and check it in to the repository, so that it's available during the Netlify build process.

@clay-aptos
Copy link
Contributor Author

It's possible that the process for generating the list of authors doesn't work when we're building for Netlify (it won't work for example if Netlify does a shallow clone instead of retrieving the full git history). If that's the case, we can adjust the build process so that we manually generate a JSON file of the authors locally, and check it in to the repository, so that it's available during the Netlify build process.

Thanks, @zacharydenton . That would be great!

@clay-aptos
Copy link
Contributor Author

Actually, this still isn't working. Asking @zacharydenton for an update. Thanks, Zach!

@clay-aptos
Copy link
Contributor Author

I am noting we need to manually regenerate this list per:
https://github.com/aptos-labs/aptos-core/tree/main/developer-docs-site#re-generate-contributors

I will do so weekly. In the long term, Zach says we can try to implement this:
https://medium.com/@songulerdemguler/running-scheduled-code-on-github-8e6a03a8d88b

Reopening for tracking. Thanks, @zacharydenton !

@github-actions
Copy link
Contributor

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

@github-actions github-actions bot added the Stale label Feb 27, 2023
@clay-aptos
Copy link
Contributor Author

I do this manually on a weekly basis and so am closing this out.

@clay-aptos
Copy link
Contributor Author

Reopening as @saharct has expressed interest in generating the .json file

@clay-aptos
Copy link
Contributor Author

Adding @banool so he knows we are looking to automate this and perhaps guide Christian on GH actions.

@github-actions github-actions bot removed the Stale label Mar 31, 2023
@clay-aptos clay-aptos assigned clay-aptos and unassigned clay-aptos Apr 13, 2023
@github-actions
Copy link
Contributor

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

@github-actions github-actions bot added the Stale label May 29, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment