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

Make it easy to view tutorials before deploying #85

Closed
chapulina opened this issue Sep 24, 2020 · 1 comment
Closed

Make it easy to view tutorials before deploying #85

chapulina opened this issue Sep 24, 2020 · 1 comment
Assignees
@azeey
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed infrastructure Requires changes on the web server or other infra

Comments

@chapulina
Copy link
Contributor

chapulina commented Sep 24, 2020 •
edited
Loading

I believe the only way to check locally if the tutorials have all the correct links is to run the site's backend server and frontend static code, which are private. People often assume links, images, embedded HTML will work the same way as on GitHub's preview, and that's not the case.

We need a way for contributors to easily check that their tutorials are rendering correctly before opening a pull request. This should also help reviewers.

This could be viewing the tutorials locally, or deploying a branch to a test URL on every PR / commit.
@chapulina chapulina added enhancement New feature or request infrastructure Requires changes on the web server or other infra labels Sep 24, 2020
@chapulina chapulina mentioned this issue Sep 24, 2020
Merged
@chapulina chapulina added the documentation Improvements or additions to documentation label Sep 24, 2020
@chapulina chapulina mentioned this issue Jan 19, 2021
Merged
@chapulina chapulina mentioned this issue Feb 17, 2021
Open
@chapulina chapulina added the help wanted Extra attention is needed label Nov 15, 2021
@chapulina chapulina changed the title Make it easy to view tutorials locally before deploying Make it easy to view tutorials before deploying Mar 10, 2022
@azeey azeey assigned azeey and unassigned mjcarroll Dec 5, 2023
@azeey azeey mentioned this issue Dec 5, 2023
Closed
@azeey
Copy link
Contributor

azeey commented Jul 18, 2024

Fixed by #441. It is now possible to build documentation locally. The Github Action workflows also generate the artifacts that can be viewed by PR authors.

@azeey azeey closed this as completed Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@azeey azeey

Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed infrastructure Requires changes on the web server or other infra
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@azeey @mjcarroll @chapulina