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

_redirects file support doc #1275

Merged
merged 12 commits into from
Sep 27, 2022
Merged

_redirects file support doc #1275

merged 12 commits into from
Sep 27, 2022

Conversation

TMoMoreau
Copy link
Contributor

Creating the branch and adding the page to config.js. This is for the "Gateway redirects" end-user doc.

Spec: ipfs/specs#290

@netlify
Copy link

netlify bot commented Sep 7, 2022

Deploy Preview for neon-choux-85b010 ready!

Name Link
🔨 Latest commit 11b53bc
🔍 Latest deploy log https://app.netlify.com/sites/neon-choux-85b010/deploys/6318bd4194fbab000ddafbda
😎 Deploy Preview https://deploy-preview-1275--neon-choux-85b010.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@TMoMoreau TMoMoreau marked this pull request as draft September 7, 2022 15:10
@TMoMoreau
Copy link
Contributor Author

TMoMoreau commented Sep 7, 2022

This is a very rough draft of what will be the gateway redirects doc. A lot of this was just pulled directly from the spec here: ipfs/specs#290.

Things that still need to be done:

  • Get a quick review for accuracy and relevancy.
  • Expand on concepts and uses as needed, pretty bare-bones ATM.
  • Polish the doc as a whole, make more end-user friendly.

@BigLep
Copy link
Contributor

BigLep commented Sep 8, 2022

2022-09-08 conversation:

  1. don't document the old behavior.
  2. This can get merged after it lands in Kubo

@TMoMoreau TMoMoreau changed the title Creating branch and adding the page to config.js Gateway redirects documentation Sep 8, 2022
Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

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

Thank you @TMoMoreau, I did a quick style pass and left some notes / suggestions on how to make this more friendly to end-users.

docs/how-to/websites-on-ipfs/gateway-redirects.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/gateway-redirects.md Outdated Show resolved Hide resolved
docs/.vuepress/config.js Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/gateway-redirects.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/gateway-redirects.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/gateway-redirects.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/gateway-redirects.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/gateway-redirects.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/gateway-redirects.md Outdated Show resolved Hide resolved
@TMoMoreau TMoMoreau changed the title Gateway redirects documentation _redirects file support doc Sep 12, 2022
@lidel lidel mentioned this pull request Sep 20, 2022
Copy link
Contributor

@johnnymatthews johnnymatthews left a comment

Choose a reason for hiding this comment

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

There's a few changes I've suggested here. On top of those, here's some stuff you'll need to change:

  1. Don't use formatting (code blocks, italics, bolding, etc) in headers.
  2. Use - for bullet points.
  3. In examples, make the reader the subject, not the writer. So use you must xyz instead of I need to xyz.
  4. Always assign code blocks a syntax. If there isn't a syntax available use ```plaintext.
  5. There should only be 1 top-level header (# Header). The title: variable in the front-matter acts as the page's top-level header. You need to increase every header in this article by one #.

docs/how-to/websites-on-ipfs/redirects-file-support.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/redirects-file-support.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/redirects-file-support.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/redirects-file-support.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/redirects-file-support.md Outdated Show resolved Hide resolved
docs/how-to/websites-on-ipfs/redirects-file-support.md Outdated Show resolved Hide resolved
@johnnymatthews
Copy link
Contributor

Nice, thanks for adding those changes. This PR is still in draft, so let me know when you need another review.

@TMoMoreau
Copy link
Contributor Author

At this point just waiting to hear from @lidel about the actual content.

Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

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

@TMoMoreau i've pushed some changes based on ipfs/kubo#8890 (which got merged and is scheduled to ship next week in Kubo 0.16 RC ipfs/kubo#9237). Added some content and removed some + updated examples to match implementation syntax.

Please fetch my changes and give it a read. Feel free to fix any bad phrasing / bugs you see, but other than that, the scope of content should be good enough from my end :)

@TMoMoreau
Copy link
Contributor Author

Thanks @lidel! I'll go over it all and make small adjustments to format/style. If it's not done today, I'll work on it over the weekend to get ready for merge on Monday.

@lidel
Copy link
Member

lidel commented Sep 23, 2022

@TMoMoreau no rush, this can wait till Monday – the release will be Release Candidate, so its ok to have another week or so before we tag a final one :)

@TMoMoreau TMoMoreau marked this pull request as ready for review September 26, 2022 17:32
Copy link
Contributor

@johnnymatthews johnnymatthews left a comment

Choose a reason for hiding this comment

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

This looks good! Let's merge when the next release goes out.

@TMoMoreau
Copy link
Contributor Author

Removed [[toc]] from this as we don't use it anywhere else and the sidebar menu has a similar feature already.

@filecorgi
Copy link
Contributor

  • Image optimization came back clean!
  • Vuepress build was successful!

Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

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

We've shipped 0.16.0-rc1, I'm merging this so we can refer to it in Release Notes :)

Thank you @TMoMoreau for making sure these docs are ready ❤️

@lidel lidel merged commit d95f5c1 into main Sep 27, 2022
@lidel lidel deleted the feat/gateway-redirects branch September 27, 2022 18:36
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.

5 participants