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.

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

add preview docs section #1383

Merged
merged 14 commits into from
Dec 17, 2020
Merged

add preview docs section #1383

merged 14 commits into from
Dec 17, 2020

Conversation

epassaro
Copy link
Member

@epassaro epassaro commented Dec 12, 2020

Description

Add a documentation section on how to build docs in your fork to preview changes (and check you are not breaking the docs!).

Motivation and Context

Sometimes it's useful to share a preview of changes in documentation. But the most important thing is this will help to make the pipeline break less often (if users are encouraged to preview changes in documentation before merging).

How Has This Been Tested?

See: https://github.com/epassaro/tardis/actions/
and https://epassaro.github.io/tardis/development/documentation_preview.html

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have assigned/requested two reviewers for this pull request.

@codecov
Copy link

codecov bot commented Dec 12, 2020

Codecov Report

Merging #1383 (b7aebef) into master (23ac153) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1383   +/-   ##
=======================================
  Coverage   72.38%   72.38%           
=======================================
  Files          66       66           
  Lines        5098     5098           
=======================================
  Hits         3690     3690           
  Misses       1408     1408           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 23ac153...b7aebef. Read the comment docs.

@andrewfullard andrewfullard merged commit c950345 into tardis-sn:master Dec 17, 2020
atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021
* add preview docs section

* minor changes

* minor changes

* change job name

* minor changes

* minor changes

* fix typo

* add suggested changes

* add limitations subsection

* fix code block

* change index

* fix some display issues

* change page name

* minor changes to pr template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants