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

[Docs] Build out Learning Move section #5774

Closed
clay-aptos opened this issue Dec 5, 2022 · 21 comments · Fixed by #5817, #6276, #6202 or #6579
Closed

[Docs] Build out Learning Move section #5774

clay-aptos opened this issue Dec 5, 2022 · 21 comments · Fixed by #5817, #6276, #6202 or #6579
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation P1 Priority 1

Comments

@clay-aptos
Copy link
Contributor

Aptos Documentation Issue

See this issue for history:
#4748

In short, we need to:

  1. Update our existing NFT tutorial to reflect the changes made in:
    [move-examples] split NFT tutorial into smaller parts #5714
  2. Convert our internal Move Workshop Bump debian from buster-20211011 to buster-20220125 in /docker/faucet #1 on creating an NFT to external documentation.
@clay-aptos clay-aptos added bug Something isn't working documentation Improvements or additions to documentation labels Dec 5, 2022
@clay-aptos clay-aptos added the P1 Priority 1 label Dec 5, 2022
@cathyaptos
Copy link

I just want it to be clear that this work is NOT to update the current "your first NFT" tutorial but to create a new section in aptos.dev for 'Learning Move'

@clay-aptos
Copy link
Contributor Author

I just want it to be clear that this work is NOT to update the current "your first NFT" tutorial but to create a new section in aptos.dev for 'Learning Move'

Please work with @movekevin to define your desires here as we already have this section of docs:
https://aptos.dev/guides/move-guides/aptos-move-guides

@clay-aptos
Copy link
Contributor Author

clay-aptos commented Dec 7, 2022

Also @cathyaptos , are you saying we don't need to update the existing Your First NFT tutorial to reflect @0xchloe 's changes? If we do, let's track that here too. If not, I will remove the item.

Adding @davidiw for guidance on prioritization and collaboration. Who is leading this charge?

@clay-aptos clay-aptos changed the title [Docs] Improve First NFT Tutorial [Docs] Build out Learning Move section Dec 7, 2022
@clay-aptos
Copy link
Contributor Author

Finally, @cathyaptos to expedite your request please have the team draft new workshop materials in GitHub for all to benefit rather than in internal docs that must be merged in later.

@clay-aptos clay-aptos linked a pull request Dec 7, 2022 that will close this issue
@clay-aptos
Copy link
Contributor Author

See progress and help with it at:
#5817

@0xchloe
Copy link
Contributor

0xchloe commented Dec 8, 2022

Ah yeah, agree with cathy that we intend to create a new Learn Move section instead of Your First NFT. I guess using the existing Move on Aptos could work too? But it seems like Move on Aptos is more on Move concepts and less like hands-on tutorials, except the Your First Move Module section. @movekevin @cathyaptos wdyt? Should we put the new tutorials under Move on Aptos or create a new section Learn Move?
Also, we don't need to update the existing Your First NFT tutorial because that's targeting the SDK developers, and this tutorial is more targeting smart contracts developers.

@cathyaptos
Copy link

I think we should put it under Move on Aptos but have its new subsection like "Move Tutorials" or "Learn Move via Tutorials" or something :)

@cathyaptos
Copy link

@movekevin lmk if you agree!

@movekevin
Copy link
Contributor

I'm thinking we can put that in both the Build App's index page and Move on Aptos.

@cathyaptos
Copy link

cathyaptos commented Dec 8, 2022 via email

@clay-aptos
Copy link
Contributor Author

clay-aptos commented Dec 8, 2022

Please see progress in:
#5817

And note Move on Aptos now contains only one conceptual doc: How Base Gas Works
We can certainly create a Tutorials subsection there or similar when we have many of them.

Here is a TODO from the PR: Find out why I get "No collectibles yet." Confirm the private key is emitted in the output above as it says account. If not from there, where do they derive this essential ingredient?

And another for the Move on Aptos index:
TODO: Link from the first list to resources for each.

@cathyaptos
Copy link

Amazing! @0xchloe in the new section should we actually have the materials from workshop #2 go before the materials for workshop #1 since today's workshop was Move basics?

@cathyaptos
Copy link

To be clear :) We can publish workshop #1 first but when we publish workshop #2 let's make sure it's higher up in the order

(aka. no change to current workflow, just commenting on the where to publish it)

@clay-aptos
Copy link
Contributor Author

To be clear :) We can publish workshop #1 first but when we publish workshop #2 let's make sure it's higher up in the order

(aka. no change to current workflow, just commenting on the where to publish it)

Makes sense to me. Will keep you posted.

@clay-aptos
Copy link
Contributor Author

I am noting @perryjrandall requested a diagram during workshop #1 depicting the relationship of the various accounts (admin, source, and resource) and smart contracts.

@clay-aptos
Copy link
Contributor Author

@movekevin, we describe admin and source accounts in the Move Workshop #1 @0xchloe presented, yet we don't describe them in:
https://aptos.dev/concepts/accounts/

Should we? We instead say:

There are two types of accounts in Aptos:

Standard account - This is a typical account corresponding to an address with a corresponding pair of public/private keys.
Resource account - An autonomous account without a corresponding private key used by developers to store resources or publish modules on chain.

@movekevin
Copy link
Contributor

I don't think we need to call that out on the accounts page. That's internal to how resource accounts work and are created. We should add those details on the specific resource account page/guide.

@clay-aptos
Copy link
Contributor Author

Noting progress on the NFT front in:
#6266

We should follow this up with an NFT index that summarizes all docs in this section after the Mint Tool and property map docs land. Putting here so the team can help me remember.

@clay-aptos
Copy link
Contributor Author

Hi team, I believe I have addressed all feedback in PR#5872 and then abandoned/recreated it with:
#6296

As the former was woefully out of sync with main. Please take a quick look and approve so we don't run into more conflicts. Thanks, all.

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Aptos Docs Jan 27, 2023
@clay-aptos clay-aptos reopened this Jan 30, 2023
@clay-aptos
Copy link
Contributor Author

Hi team,

All that remains here is:
#6202

Once that is in, I am shifting to more Move docs in:
#6375

Please let me know how to help. Thanks!

@clay-aptos
Copy link
Contributor Author

Hi @areshand and team,

Thanks for getting the airdrop and propertymap docs in. I am now integrating and announcing them in:
#6579

Please see them staged at:
https://deploy-preview-6579--aptos-developer-docs.netlify.app/whats-new-in-docs/
https://deploy-preview-6579--aptos-developer-docs.netlify.app/concepts/coin-and-token/airdrop-aptos-tokens/
https://deploy-preview-6579--aptos-developer-docs.netlify.app/concepts/coin-and-token/propertymap-offchain/

And let me know if you feel they are misplaced. Thanks!

@clay-aptos clay-aptos moved this from ✅ Done to 👀 In review in Aptos Docs Feb 15, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Aptos Docs Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment