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.

Sign up for GitHub

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

Jump to bottom

Custom domain doc improvements #10719

Merged
merged 8 commits into from
Sep 22, 2023
Merged

Custom domain doc improvements #10719

merged 8 commits into from
Sep 22, 2023

Conversation

agjohnson
Copy link
Contributor

@agjohnson agjohnson commented Sep 7, 2023 •
edited by github-actions bot
Loading

The custom domain docs suffered a few issues I've wanted to address:

  • Talked about some tangential topics, where this was meant more as a feature
    overview page
  • Features of custom domains weren't super clear, feature mentions were spread
    out
  • Notes for open source maintainers were dropped as these seemed out of place
  • "How custom domains work" contained duplicate content to our set up guide, so
    didn't exactly explain how custom domains work.
  • Explain our default subdomains better
  • Drop custom domain mermaid graphic. I don't feel this improves the user
    understanding of how custom domains work, and seems to be a pain to update to
    make it more helpful.

📚 Documentation previews 📚

@agjohnson
Drop custom domain mermaid graphic
e597787 
I don't feel this improves the user understanding of how custom domains
work, and seems to be a pain to update to make it more helpful. Removing
this for now.
@agjohnson
Explain our default subdomains better
094b6e8 
Mention organization name as well, but don't surface the word "slug" as
"name" is more relateable to the user.
@agjohnson
Remove custom domain guidance for open source projects
46d3e76 
This stands out as misplaced content for our feature page on custom domains.
@agjohnson
Rework set up notes and "how custom domains work" into features section
660fcb1 
This drops "how custom domains work", which was some duplicate content
of our how to set up custom domains guide. Content that leaned more
towards describing the features of custom domains was reworked into a
feature section that lists the features that make up custom domain
support.
@agjohnson
Backwards link syntax
1870f8e
@agjohnson agjohnson requested a review from a team as a code owner September 7, 2023 23:49
@agjohnson @stsewd
Remove missed extra word
7b60ef4 
Co-authored-by: Santos Gallegos <stsewd@proton.me>
ericholscher
ericholscher approved these changes Sep 12, 2023
View reviewed changes
docs/user/custom-domains.rst Outdated Show resolved Hide resolved
@agjohnson @ericholscher
Update docs/user/custom-domains.rst
e17303d 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
@agjohnson agjohnson merged commit 7c670b8 into main Sep 22, 2023
2 checks passed
@agjohnson agjohnson deleted the agj/docs-custom-domain branch September 22, 2023 23:42
@humitos humitos mentioned this pull request Feb 21, 2024
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stsewd stsewd stsewd left review comments

@ericholscher ericholscher ericholscher approved these changes

Assignees

@agjohnson agjohnson

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@agjohnson @ericholscher @stsewd