-
Notifications
You must be signed in to change notification settings - Fork 416
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
Conversation
✅ Deploy Preview for neon-choux-85b010 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
This is a very rough draft of what will be the Things that still need to be done:
|
2022-09-08 conversation:
|
config.js
There was a problem hiding this 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.
_redirects
file support doc
There was a problem hiding this 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:
- Don't use formatting (code blocks, italics, bolding, etc) in headers.
- Use
-
for bullet points. - In examples, make the reader the subject, not the writer. So use
you must xyz
instead ofI need to xyz
. - Always assign code blocks a syntax. If there isn't a syntax available use ```plaintext.
- There should only be 1 top-level header (
# Header
). Thetitle:
variable in the front-matter acts as the page's top-level header. You need to increase every header in this article by one#
.
Nice, thanks for adding those changes. This PR is still in draft, so let me know when you need another review. |
At this point just waiting to hear from @lidel about the actual content. |
Based on things provided by ipfs/kubo#8890
There was a problem hiding this 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 :)
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. |
@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 :) |
There was a problem hiding this 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.
Removed |
|
There was a problem hiding this 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 ❤️
Creating the branch and adding the page to
config.js
. This is for the "Gateway redirects" end-user doc.Spec: ipfs/specs#290