Test acceleration docs v2 #327

prichhazed · 2021-08-16T10:31:38Z

dinamlev · 2021-08-23T21:20:47Z

docs/test acceleration/getting-started/pytest.md

+---
+
+# Try in pytest
+{:.no_toc}


Not sure what's going on with the table of contents here and elsewhere

dinamlev · 2021-08-26T15:05:31Z

docs/cli/ci-caching.md

@@ -1,5 +1,5 @@
 ---
-parent: CI and CLI Documentation
+parent: CI and CLI


You'll want to sync to the latest changes in the repo to pick up the CI/CLInav updates, etc. before sending this out for review.

dinamlev

Hi Priyanshu,

I've left some comments on your change. I think it would be best to work from the docs.yourbase.io repository with the new content so that we can be looking at a preview of the site at the same time. Would you mind addressing these requests in a new PR for that repository?

Thank you!

dinamlev · 2021-08-26T15:10:41Z

docs/index.md

- Ruby Test Acceleration - Coming soon! Contact us at [hi@yourbase.io](mailto:hi@yourbase.io) if you
-  want to join the private beta.
+# YourBase
+Some text talking about test acceleration & links to CI CLI.


Since we are hiding the CLI info, this section seems extraneous - thoughts?

Yes. I've removed this page altogether. And set the "Home" page to the introduction to Test Acceleraiton.
Also, I've moved all CLI pages under the cli folder, and also marked them to be excluded from the navigation.

Let me know your thoughts.

dinamlev · 2021-08-26T15:12:49Z

docs/CNAME

@@ -1 +1 @@
-docs.yourbase.io
+prichhazed.github.io


this should not be changed in prod

dinamlev · 2021-08-26T15:13:00Z

docs/_config.yml

 baseurl: "" # the subpath of your site, e.g. /blog
-url: https://docs.yourbase.io
-domain: docs.yourbase.io
+url: https://prichhazed.github.io/yb


this should not be changed in prod

dinamlev · 2021-08-26T15:13:01Z

docs/_config.yml

-url: https://docs.yourbase.io
-domain: docs.yourbase.io
+url: https://prichhazed.github.io/yb
+domain: prichhazed.github.io


this should not be changed in prod

dinamlev · 2021-08-26T15:15:39Z

docs/python-getting-started/index.md

@@ -1,15 +0,0 @@
-<!--


We usually keep/add redirect pages for SEO purposes - same for other deleted files.

dinamlev · 2021-08-26T15:20:05Z

docs/test acceleration/index.md

+
+---
+
+## Will it provide benefits at your scale? 


UX note: better for second person words to be first person - substitute "your" with "my" in the question

dinamlev · 2021-08-26T15:20:14Z

docs/test acceleration/index.md

+
+---
+
+## Is it compatible with your tech-stack and infrastructure?


UX note: better for second person words to be first person - substitute "your" with "my" in the question

dinamlev · 2021-08-26T15:24:27Z

docs/test acceleration/reference/configuration-options.md

+</details>
+
+## YOURBASE_ACCEPT_TOS
+`Type`: `bool-ish (0, false, off, 1, true, on)`


formatting for the type + default does not look right - currently appears all on same line - please could you address for all options?

dinamlev · 2021-08-26T15:25:08Z

docs/test acceleration/reference/configuration-options.md

+
+When on, YourBase Test Acceleration will use a slower tracing algorithm that is less prone to conflicts with other packages than the default. 
+
+We recommend reaching out to support@yourbase.io if you are encountering this scenario, and only enabling this if you experience issues with the default algorithm. 


Please could you add mailto links wherever email addresses appear in the PR, e.g. for support@yourbase.io, hi@yourbase.io? Thank you!

example: hi@yourbase.io

dinamlev · 2021-08-26T15:30:14Z

docs/test acceleration/reference/common-issues.md

+
+## Conflict with plugin pytest-xdist
+
+The YourBase Test Acceleration Test Selection and pytest-xdist [link] plugins have similar goals, reducing the overall test execution time of tests, but take different approaches to solving the problem. As such, there are conflicts when both plugins are enabled. When using the YourBase Test Acceleration Test Selection plugin, please uninstall pytest-xdist or execute pytest-xdist with `NUMCPUS=0`


missing a link

Priyanshu Chhazed and others added 19 commits August 15, 2021 17:04

Added first three sections

dd6df09

Added all test acceleration files

f50cb41

Trying to fix main nav

6d3cd52

Removed old python pages

9d3bf5f

Moved cli md files to its docs/cli folder

d1833ff

Changed url to prichhazed.github.io

259dd1d

Changed CNAME to prichhazed.github.io

c64fad6

Removed search related JTD configuration

ea84144

Fixed GH pages URL

8c75636

Fixed most of the main navigation

7e60f2f

Fixed code highlights

0b96a12

Fixed hierarchy issue

f807883

Fixed config, added some links

66faa53

Fixed config

996fe43

Added CI CLI docs

978b6bd

Added internal links part 1

9762e46

Added links in Advnced usage

17a6eba

Added all links

8cb4375

removed cli doc

4546006

prichhazed marked this pull request as ready for review August 23, 2021 12:32

prichhazed added 4 commits August 23, 2021 19:50

Changes to rollout recos

d2f1fee

Fixed deploying pages

2748efe

Added url changes for hosting on GH pages on priyanshu's account

d87b463

Added index.md in docs folder

7d6f45d

dinamlev reviewed Aug 23, 2021

View reviewed changes

Fixed nav order

355fdcf

dinamlev reviewed Aug 26, 2021

View reviewed changes

dinamlev suggested changes Aug 26, 2021

View reviewed changes

		@@ -1 +1 @@
		docs.yourbase.io No newline at end of file
		prichhazed.github.io No newline at end of file


		---

		## Is it compatible with your tech-stack and infrastructure?


		When on, YourBase Test Acceleration will use a slower tracing algorithm that is less prone to conflicts with other packages than the default.

		We recommend reaching out to support@yourbase.io if you are encountering this scenario, and only enabling this if you experience issues with the default algorithm.


		## Conflict with plugin pytest-xdist

		The YourBase Test Acceleration Test Selection and pytest-xdist [link] plugins have similar goals, reducing the overall test execution time of tests, but take different approaches to solving the problem. As such, there are conflicts when both plugins are enabled. When using the YourBase Test Acceleration Test Selection plugin, please uninstall pytest-xdist or execute pytest-xdist with `NUMCPUS=0`

Test acceleration docs v2 #327

Are you sure you want to change the base?

Test acceleration docs v2 #327

Uh oh!

Conversation

prichhazed commented Aug 16, 2021

Uh oh!

dinamlev Aug 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dinamlev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

prichhazed Aug 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dinamlev Aug 23, 2021 •

edited

Loading

prichhazed Aug 30, 2021 •

edited

Loading