Docusaurus: README update #33849
Merged
Docusaurus: README update #33849
+58
−16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Warning Soft code freeze is in effect until 2024-01-02. Please avoid merging to master. #freedom-and-responsibility |
natikgadzhi
added
area/documentation
- General update and structure. - Note on relative link checking. - Changed GH pages to Vercel.
natikgadzhi
force-pushed
the
natikgadzhi/docs/readme
branch
from
590ab1d to
6725c2a
Compare
octavia-squidington-iii
removed
the
area/documentation
erohmensing
approved these changes
Jan 2, 2024
| ```bash | ||
| yarn start # any changes will automatically be reflected in your browser! | ||
| ``` | ||
|
|
||
| ## Making Changes | ||
| All the content for docs.airbyte.com lives in the `/docs` directory in this repo. All files are | ||
| markdown. Make changes or add new files, and you should see them in your browser! |
There was a problem hiding this comment.
Caveat: adding new files and seeing them requires changing the sidebar (thanks for separating out the next section to make it clearer!), so you can't see this with yarn start. I believe if you need to change the sidebar, you have to run build again (unconfirmed)
There was a problem hiding this comment.
Mmmm, I'll double check!
Co-authored-by: Ella Rohm-Ensing <[email protected]>
|
@erohmensing thank you! ❤️ |
jatinyadav-cc
pushed a commit
to ollionorg/datapipes-airbyte
that referenced
this pull request
Feb 26, 2024
Co-authored-by: Ella Rohm-Ensing <[email protected]>
jatinyadav-cc
pushed a commit
to ollionorg/datapipes-airbyte
that referenced
this pull request
Feb 26, 2024
Co-authored-by: Ella Rohm-Ensing <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request clarifies how we build the documentation website. No actual code changes, safe to ship once the content feels right.
What's there:
Why now
I've broken a few links in #33839, and @erohmensing and @evantahler linked me to it, and I'm just trying to clean things up as I learn.
Next Steps
It looks like we have quite a few links that are broken in the CI run.
Some of them are perhaps false positives and we need to clean the exception rules, but some of them are legit 404s (Zoom Marketplace for example). Not the biggest problem in the world, but would be good to grind through.