Docs links updates #6993
Merged
Docs links updates #6993
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
raddevon
reviewed
Mar 6, 2024
| @@ -378,7 +378,7 @@ This exposes the webserver in port 5000. Now, in your browser, go to | |||
| find that the HTTP basic auth requires us to provide the username and password. | |||
|
|
|||
| .. image:: | |||
| https://www.edgedb.com/docs/tutorials/strawberry/http_basic.png | |||
| /docs/tutorials/strawberry/http_basic.png | |||
There was a problem hiding this comment.
When I pull this down and run it locally, these images are not loading for me. They work on the live copy (at docs.edgedb.com), but I'm guessing that's just until the site changes are deployed, which might remove those images at their current locations. Not sure what these paths should be to make them work though. I thought maybe just /docs needed to go away, but that didn't seem to work either… 🤔
There was a problem hiding this comment.
These changes depend on this PR: https://github.com/edgedb/edgedb.com/pull/823. Currently those images are still being loaded from the main site, which will break when the docs-less main site goes live.
jaclarke
force-pushed
the
docs-links-updates
branch
from
466b2a6 to
be44b30
Compare
raddevon
approved these changes
Mar 6, 2024
raddevon
pushed a commit
that referenced
this pull request
Mar 6, 2024
* Update some docs links to use refs + add/remove host for some links to work with new docs site * Fix CI * Convert more client lib links to refs * Add query parameter types heading ref * Ignore missing ref errors for client docs
raddevon
added a commit
that referenced
this pull request
Mar 7, 2024
* Update installation method links * Link to library docs instead of repos * Update showcase links * Add missing client libraries * Remove redundant docs link The user is already in the docs * Refer to these by our name for them Seems weirdly inconsistent to try to use a more generic name for access policies here. We should call them by the name we call them. This will otherwise be confusing, especially when a user clicks "Object-level security" and lands on a page called "Access policies." * Set correct link targets These both pointed to the top of the "Select" page instead of to the appropriate sections. * Update to documentation links instead of linking to the clients' GitHub repos * Convert headings to proper HTML headings * Add missing cheatsheets * Mention Cloud in section about `EDGEDB_INSTANCE` * Web -> web * Fix link target for redeploying EdgeDB instance * Add missing slash to showcase links * Expand link label Link goes to client connection configuration settings documentation rather than client connection documentation. Better for accessibility to expand the label to include "settings." * Update deployment guide links * Fix book link * Update to reflect Elixir client is now blessed * Add missing underscore * Docs links updates (#6993) * Update some docs links to use refs + add/remove host for some links to work with new docs site * Fix CI * Convert more client lib links to refs * Add query parameter types heading ref * Ignore missing ref errors for client docs * Update docs/guides/datamigrations/postgres.rst Co-authored-by: Aleksandra <[email protected]> * Format library lists as proper lists --------- Co-authored-by: James Clarke <[email protected]> Co-authored-by: Aleksandra <[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.
Related PR: https://github.com/edgedb/edgedb.com/pull/823