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

Explains Gateway, origin, dnslink, & Jonny's requests #1025

Closed
wants to merge 8 commits into from

Conversation

Annamarie2019
Copy link
Contributor

@Annamarie2019 Annamarie2019 commented Feb 10, 2022

  • Removes parentheses.
  • Makes "accommodates" sentence a full sentence
  • provides same-origin link in wikipedia
  • provides dnslink link in our glossary

This resolves Johnny's requests for PR #1016, which I did in another workflow. Closing PR#1016. Future workflows will be in this Branch workflow (unless otherwise requested).

@Annamarie2019 Annamarie2019 changed the title Explains Gateway origin dnslink & Jonny's requests Explains Gateway, origin, dnslink, & Jonny's requests Feb 10, 2022
@johnnymatthews
Copy link
Contributor

it looks like this PR has some conflicts with #1022. Which one should we keep open?

@Annamarie2019
Copy link
Contributor Author

This one.

(Future PRs should go more smoothly. This one got caught in the learning curve, so the second one adds improvements.)

@johnnymatthews
Copy link
Contributor

johnnymatthews commented Feb 16, 2022

This one.

Ok, sounds good. You'll have to manually move over my suggestions from #1022 though (if you haven't already).

@Annamarie2019
Copy link
Contributor Author

I did. I'll put a comment there to remind you.

@@ -26,6 +26,9 @@ The quickest way to get IPFS up and running on your machine is by installing [IP

For installing and initializing IPFS from the command line, check out the [command-line quick start](../how-to/command-line-quick-start.md) guide.

### Why doesn't my SHA hash match my CID?
Copy link
Contributor

Choose a reason for hiding this comment

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

Add empty line after title.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Found it and fixed it.

@@ -39,8 +35,11 @@ For example, the SHA-256 hash of "Hello world" from above can be represented as
```
mtwirsqawjuoloq2gvtyug2tc3jbf5htm2zeo4rsknfiv3fdp46a
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Add empty line after codeblocks. Also, try and give each codeblock syntax highlighting. If there isn't a syntax we can use, like in this case, use plaintext intstead.

Suggested change
```
```plaintext


## Content identifiers are not file hashes
## Example: Content Identifiers are not file hashes
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this section be under the section header on line 42? If so, let's add another # to this section header.

@Annamarie2019
Copy link
Contributor Author

Annamarie2019 commented Feb 24, 2022

I added the line after the title and the code. For line 42, I think the word "Example" makes you think that it should be a level 3 heading, so I took that out. I explain it in the first paragraph instead.

For the syntax highlighting. I don't know how to do that. I can add the word plaintext in the editor, but it just shows up as text. In Atom, I get options, but none of them are plaintext. There's some suggestion in Google that I need to add a package for that but it does it automatically, not as an attribute. Maybe @JohnMulhausen knows. (I left John a note for his github name.)
syntxhighlighting

@Annamarie2019
Copy link
Contributor Author

@johnnymatthews I got this back in my email again still with 1 change requested and merging blocked, but I think I've fixed everything: Added lines after title and code, added the syntax highlighting, and fixed problem with the heading level (Took out "Example" which implied deeper level).
If you don't have any more requests, when does this back and forth end and the changes get merged?

@filecorgi

This comment was marked as off-topic.

@Annamarie2019
Copy link
Contributor Author

Yes, all of my branches/PRs have extraneous files pulled in to them. So I need to meet with @johnnymatthews or @johndmulhausen to determine how to fix them. May need to close this and create new branch and PR.

@Annamarie2019 Annamarie2019 deleted the gateway-origin-dnslink branch February 28, 2022 16:53
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.

3 participants