Skip to content

Conversation

salmad3
Copy link
Contributor

@salmad3 salmad3 commented Aug 1, 2022

Closes #1207

  • adds steps as proposed in issue. leaves out the more interactive pieces (such as dialog and input box)
  • proposes the use of tabs: using an external plugin which can be changed
  • modifies and updates JS content

@welcome
Copy link

welcome bot commented Aug 1, 2022

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
  • Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
  • The PR gets reviews, discussed and approvals as needed.
  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@salmad3 salmad3 marked this pull request as draft August 1, 2022 01:21
@salmad3 salmad3 changed the title Basics of JS IPFS Basics of JS-IPFS: Install/Spawn Aug 3, 2022
@salmad3 salmad3 marked this pull request as ready for review August 3, 2022 17:24
@johnnymatthews
Copy link
Contributor

johnnymatthews commented Aug 4, 2022

This looks fun! There's some weird stuff going on with the tabs though. Clicking on one of the tabs under Install JS-IPFS jumps me down to the next section:

Screen.Recording.2022-08-04.at.3.37.20.PM.mov

@salmad3 salmad3 changed the title Basics of JS-IPFS: Install/Spawn Basics of JS-IPFS Aug 8, 2022
@johnnymatthews
Copy link
Contributor

It looks like that tabs plugin you used has been abandoned. I'm trying out https://github.com/Kaifuny/vuepress-plugin-tabs instead. Gonna convert this PR to a draft since I'm working on it.

@johnnymatthews johnnymatthews marked this pull request as draft August 11, 2022 19:10
@johnnymatthews
Copy link
Contributor

Made a few changes to the formatting and copy. I also fixed the tab problem we hit earlier.

Just a few notes @DannyS03:

  1. When listing steps, us an ordered list:

    Lorem ipsum:
    
    1. First do this.
    1. Then do that.
    1. Finally, do this other thing.
  2. Use markdown syntax for images:

    ![This is the image alt text.](./images/thingy.png)
  3. Try and use 4 spaces when indenting. The markdown parser specifically looks for 4 spaces, not 2.

    1. You should obtain an output similar to:
    
        ```shell
        Added file: test.txt CID(QmYt9ypyGsR1BKdaCGPdwdBgAiuXK5AYN2bGSNZov7YXuk)
        ```
    
    1. More steps.
    1. Even more steps.

There's also a few TODOs sprinkled through the js-ipfs.md file. Ping me again when you've addressed those.

@salmad3
Copy link
Contributor Author

salmad3 commented Aug 15, 2022

@johnnymatthews addressed

@salmad3 salmad3 marked this pull request as ready for review August 15, 2022 03:56
@salmad3
Copy link
Contributor Author

salmad3 commented Aug 15, 2022

With the tabs addition added, will create an issue after this is merged to propose a similar approach for kubo basics

@salmad3 salmad3 mentioned this pull request Aug 15, 2022
@salmad3 salmad3 closed this Aug 31, 2022
@netlify
Copy link

netlify bot commented Aug 31, 2022

Deploy Preview for neon-choux-85b010 failed.

Name Link
🔨 Latest commit 3760590
🔍 Latest deploy log https://app.netlify.com/sites/neon-choux-85b010/deploys/63151b409b67110008a2caae

@salmad3 salmad3 mentioned this pull request Aug 31, 2022
@salmad3 salmad3 reopened this Sep 4, 2022
@salmad3 salmad3 merged commit 5467363 into ipfs:main Sep 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create an section covering the Basics of IPFS using JavaScript.

5 participants