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.

Sign up for GitHub

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

Jump to bottom

Build Help section, community highlights list, external resources, and docs instructions #6417

Merged
merged 24 commits into from
Mar 7, 2023
Merged

Build Help section, community highlights list, external resources, and docs instructions #6417

merged 24 commits into from
Mar 7, 2023

Conversation

clay-aptos
Copy link
Contributor

@clay-aptos clay-aptos commented Jan 31, 2023 •
edited
Loading

Description

This also restores the Rust coding guidelines deleted from the repo in:
6617cc4#diff-deb6d1d935e5598636ce61fa0d258708e9daa897885c784892b7cb8d473034fd

Test Plan

@clay-aptos clay-aptos requested a review from davidiw as a code owner January 31, 2023 07:04
@clay-aptos clay-aptos marked this pull request as draft January 31, 2023 07:04
@clay-aptos
Copy link
Contributor Author

@alnoki , I am proposing highlights (docs and code) from community members. See this PR and the staging URL for a preview:
https://deploy-preview-6417--aptos-developer-docs.netlify.app/contribute/community-highlights

@clay-aptos clay-aptos mentioned this pull request Feb 1, 2023
Closed
@alnoki
Copy link
Contributor

alnoki commented Feb 1, 2023

@alnoki , I am proposing highlights (docs and code) from community members. See this PR and the staging URL for a preview: https://deploy-preview-6417--aptos-developer-docs.netlify.app/contribute/community-highlights

@clay-aptos thanks for the mention! The only think that I'll point out is concatenating my GitHub alias name to "alnoki"

@alnoki alnoki mentioned this pull request Feb 1, 2023
Closed
@clay-aptos clay-aptos linked an issue Feb 3, 2023 that may be closed by this pull request
[Docs] Create Contribute section and highlight internal and external contributions #6311
Closed
@clay-aptos clay-aptos mentioned this pull request Feb 3, 2023
Closed
@clay-aptos clay-aptos changed the title Start building out Contribute section and Community Highlights list Start building out Contribute section, Community Highlights list, and FAQ Feb 3, 2023
@clay-aptos
Copy link
Contributor Author

Let's also link to:
https://stackoverflow.com/questions/tagged/aptos

This was referenced Feb 14, 2023
Closed
Merged
@clay-aptos clay-aptos marked this pull request as ready for review February 21, 2023 16:41
@clay-aptos
Copy link
Contributor Author

Adding Tau for his guidance as we build this process out:
@rusiqe

@clay-aptos clay-aptos force-pushed the contribute-highlights branch from 3169df2 to 538f7ef Compare February 21, 2023 17:57
@clay-aptos clay-aptos marked this pull request as draft February 21, 2023 17:57
@clay-aptos clay-aptos linked an issue Feb 22, 2023 that may be closed by this pull request
[RFE] Create FAQ for common Q&A #5520
Closed
@clay-aptos clay-aptos force-pushed the contribute-highlights branch 3 times, most recently from 07f5a54 to 4210330 Compare February 27, 2023 23:42
@clay-aptos clay-aptos changed the title Start building out Contribute section, Community Highlights list, and FAQ Build Contribute section, community highlights list, external resources, and docs instructions Feb 28, 2023
@clay-aptos clay-aptos force-pushed the contribute-highlights branch from b5b5861 to 60c4917 Compare February 28, 2023 17:56
@clay-aptos clay-aptos requested a review from JoshLind February 28, 2023 20:07
@clay-aptos clay-aptos force-pushed the contribute-highlights branch from d079124 to baa50f8 Compare February 28, 2023 20:15
@clay-aptos clay-aptos changed the title Build Contribute section, community highlights list, external resources, and docs instructions Build Help section, community highlights list, external resources, and docs instructions Feb 28, 2023
@clay-aptos clay-aptos marked this pull request as ready for review February 28, 2023 20:17
@clay-aptos
Copy link
Contributor Author

Hi team,

This is all ready for review except the FAQ, which needs much work internally. I can remove from this PR. What do you think?

Clay Murphy added 17 commits March 6, 2023 11:54
Create community directory for external contributions
9c928d7
Address spelling issues in FAQ
14db7d5
Start edits to FAQ, fix link to renamed community highlights in top nav
46782fe
Finish link fixes
4421833
Introduce External Resources list
2fd52bb
Remove name for spellcheck, replace preso link text with title
ec44026
Finish first draft of Contribute index, restore Rust Coding Conventions
7b3a402
Add missing Markdown extension to fix builds
9c26454
Add first drafts of docs instructions and style guide
cc8cb77
Edit and improve contribute index and site guidance
02028f9
Improve Contribute index slug
3131748
Rename Contribute to Help for brevity, update related links
decbf74
Remove draft FAQ from Help section PR to allow longer reviewer of the…
a5565f7 
… former
Rename Help to Community, add instructions and screenshots for editin…
844edf2 
…g in GitHub
Add new terms to spellcheck dictionary
afe7ac1
Make clear new files should go in subdirs
7cadb0e
Address reviewer feedback
9d4dc0e
@clay-aptos clay-aptos force-pushed the contribute-highlights branch from 21eacf5 to 9d4dc0e Compare March 6, 2023 22:02
@clay-aptos clay-aptos mentioned this pull request Mar 7, 2023
Merged
davidiw
davidiw approved these changes Mar 7, 2023
View reviewed changes
Copy link
Contributor

@davidiw davidiw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome

@davidiw davidiw enabled auto-merge (squash) March 7, 2023 06:10
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2023

✅ Forge suite land_blocking success on 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75

performance benchmark with full nodes : 5834 TPS, 6817 ms latency, 12300 ms p99 latency,(!) expired 20 out of 2491360 txns
Test Ok

@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2023

✅ Forge suite compat success on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75

Compatibility test results for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75 (PR)
1. Check liveness of validators at old version: testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b
compatibility::simple-validator-upgrade::liveness-check : 7950 TPS, 4767 ms latency, 9100 ms p99 latency,no expired txns
2. Upgrading first Validator to new version: 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75
compatibility::simple-validator-upgrade::single-validator-upgrade : 4748 TPS, 8648 ms latency, 11200 ms p99 latency,no expired txns
3. Upgrading rest of first batch to new version: 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75
compatibility::simple-validator-upgrade::half-validator-upgrade : 4672 TPS, 8437 ms latency, 11500 ms p99 latency,no expired txns
4. upgrading second batch to new version: 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75
compatibility::simple-validator-upgrade::rest-validator-upgrade : 6671 TPS, 5657 ms latency, 10200 ms p99 latency,no expired txns
5. check swarm health
Compatibility test for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75 passed
Test Ok

@davidiw davidiw merged commit 1b1b627 into main Mar 7, 2023
@davidiw davidiw deleted the contribute-highlights branch March 7, 2023 06:53
@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2023

✅ Forge suite framework_upgrade success on cb4ba0a57c998c60cbab65af31a64875d2588ca5 ==> 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75

Compatibility test results for cb4ba0a57c998c60cbab65af31a64875d2588ca5 ==> 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75 (PR)
Upgrade the nodes to version: 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75
framework_upgrade::framework-upgrade::full-framework-upgrade : 6903 TPS, 5619 ms latency, 9100 ms p99 latency,no expired txns
5. check swarm health
Compatibility test for cb4ba0a57c998c60cbab65af31a64875d2588ca5 ==> 39b3d6b58a1c764a7ad8c770a02cb1872c23ff75 passed
Test Ok

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michelle-aptos michelle-aptos michelle-aptos approved these changes

@davidiw davidiw davidiw approved these changes

@saharct saharct Awaiting requested review from saharct

@gregnazario gregnazario Awaiting requested review from gregnazario

@JoshLind JoshLind Awaiting requested review from JoshLind

Assignees

@saharct saharct

Labels
None yet
Projects
None yet
Milestone
No milestone
5 participants
@clay-aptos @alnoki @davidiw @michelle-aptos @saharct