New docs versioning - repo proposal #1855

igor-dv · 2017-09-16T17:35:25Z

Issue: related to #1773

What I did

I've added a functionality to the docs-v2 build script that will commit a new exported docs version to a separate repo

Tasks TBD

Fix relative to root links
Fix dynamic chunks are not being downloaded for the version site.
Use/Create Storybook bot user to commit to the docs repo.
Create storybook docs repo
Add the docs repo to the CI
Add DOCS_REPO variable with access token to CI
Automate docs deployment in main storybook CI
Generate the versions.json for a versions drop-down
Fix edge case when the same exported version is generated with a different build hash (because maybe something was changed but version is still the same) : when copying to the main _next dir the old app version data should be deleted.

Example

https://storypuke-mlglazhotd.now.sh
https://storypuke-mlglazhotd.now.sh/3-0-0
https://storypuke-mlglazhotd.now.sh/3-0-1
https://storypuke-mlglazhotd.now.sh/3-2-5
https://storypuke-mlglazhotd.now.sh/3-2-9

How to test

Meanwhile:

Create a repo
Add a basic package.json - it's needed because the build script is looking for it to upgrade the version.
Create authentication token from here : https://github.com/settings/tokens
In docs-v2/package.json change the build script to this: "build": "cross-env DOCS_REPO=https://{your_user_here}:{token_from_step_3}@github.com/{repo} node scripts/build.js",
Run the build script from the step 4
Change the version in the docs-v2/package.json
Run the build script from the step 4 again to see that newer version committed to the repo as well
Optional step - host on cloud - look the now configuration here: https://github.com/igor-dv/storypuke-docs/blob/master/package.json

… I promise)

…ge.json

# Conflicts: # docs-v2/package.json

…cripts

codecov · 2017-09-17T09:36:01Z

Codecov Report

Merging #1855 into new-docs will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           new-docs    #1855   +/-   ##
=========================================
  Coverage     22.59%   22.59%           
=========================================
  Files           324      324           
  Lines          6245     6245           
  Branches        804      801    -3     
=========================================
  Hits           1411     1411           
+ Misses         4226     4224    -2     
- Partials        608      610    +2

Impacted Files	Coverage Δ
app/react/src/server/utils.js	`0% <0%> (-53.58%)`	⬇️
lib/ui/src/modules/api/configs/init_api.js	`40.47% <0%> (ø)`	⬆️
addons/info/src/components/types/proptypes.js	`16.66% <0%> (ø)`	⬆️
addons/knobs/src/base.js	`2.5% <0%> (ø)`	⬆️
lib/ui/src/modules/ui/components/layout/usplit.js	`38.7% <0%> (ø)`	⬆️
lib/components/src/navigation/menu_link.js	`0% <0%> (ø)`	⬆️
...react-native/src/manager/components/PreviewHelp.js	`0% <0%> (ø)`	⬆️
addons/knobs/src/components/types/Select.js	`7.93% <0%> (ø)`	⬆️
addons/knobs/src/KnobManager.js	`32% <0%> (ø)`	⬆️
lib/components/src/table/table.js	`0% <0%> (ø)`	⬆️
... and 25 more

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 18c784d...0f5010d. Read the comment docs.

ndelangen · 2017-09-18T06:34:31Z

docs-v2/lib/dirToTree.js

@@ -35,30 +38,33 @@ const createFile = (stat, fileName, workingDir, baseDir) => {
      name,
      title,
      isFile: true,
-      route: path.join(routeBase, routeFile),
+      route: path.posix.join(routeBase, routeFile),


Can you give some context on this?

On windows all the routes were generated with the "\" instead of "/" and it breaks routing completely.

This works on windows, though? Interesting.

Yeah, it just enforce the path to use posix style thingies..

ndelangen · 2017-09-18T06:38:17Z

docs-v2/scripts/tasks/git_commands.js

@@ -0,0 +1,22 @@
+function getGitClone(docsRepo, outputDir) {


Nice work on extracting out all these little tasks!

codecov-io · 2017-09-18T09:03:18Z

Codecov Report

Merging #1855 into new-docs will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           new-docs    #1855   +/-   ##
=========================================
  Coverage     22.59%   22.59%           
=========================================
  Files           324      324           
  Lines          6245     6245           
  Branches        804      797    -7     
=========================================
  Hits           1411     1411           
- Misses         4226     4242   +16     
+ Partials        608      592   -16

Impacted Files	Coverage Δ
app/react/src/server/utils.js	`0% <0%> (-53.58%)`	⬇️
addons/knobs/src/components/types/Color.js	`8.1% <0%> (ø)`	⬆️
app/react-native/src/preview/story_kind.js	`0% <0%> (ø)`	⬆️
lib/ui/src/modules/ui/components/menu_item.js	`19.14% <0%> (ø)`	⬆️
...modules/ui/components/stories_panel/text_filter.js	`30.98% <0%> (ø)`	⬆️
.../src/modules/ui/components/stories_panel/header.js	`29.62% <0%> (ø)`	⬆️
lib/ui/src/modules/ui/containers/layout.js	`12.5% <0%> (ø)`	⬆️
addons/knobs/src/KnobStore.js	`6.81% <0%> (ø)`	⬆️
addons/info/src/components/types/InstanceOf.js	`16.66% <0%> (ø)`	⬆️
lib/ui/src/modules/shortcuts/actions/shortcuts.js	`22.41% <0%> (ø)`	⬆️
... and 30 more

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 18c784d...2236896. Read the comment docs.

…at might be printed.

…better strategy than just publishing docs to the repo on every build in CI.

…adable

ndelangen · 2017-09-19T07:59:21Z

docs-v2/components/Link.js

+
+const versionRegex = [/^\/([0-9]+-[0-9]+-[0-9]+)\//, /^\/([0-9]+-[0-9]+-[0-9]+)$/];
+
+function getVersionHref(path, href) {


Can you explain the rationale for this?
I'm having a hard time understanding what this exactly is doing / is for?

Let's say we are browsing in https://storybook.js.org/3-2-9/help. Every link here should be related to the /3-2-9/ subdir. But the problem is that every link starts with '/' so it's actually relative to the root. In this case clicking on this link will open the wrong page (or will shot a wrong window.location that after refresh will open a wrong page).
getVersionHref is looking for the /x-x-x/ pattern and then returns the url that is base on this version.
After that it's attached to the as parameter of the next\link that will just show the right url in the window.location

ndelangen · 2017-09-19T08:00:41Z

docs-v2/lib/dirToTree.js

@@ -35,30 +38,33 @@ const createFile = (stat, fileName, workingDir, baseDir) => {
      name,
      title,
      isFile: true,
-      route: path.join(routeBase, routeFile),
+      route: path.posix.join(routeBase, routeFile),


This works on windows, though? Interesting.

ndelangen · 2017-09-19T08:01:17Z

docs-v2/lib/dirToTree.js

    }));
 };

 const createDirectory = (items, localWorkingDir, baseDir) => ({
-  route: localWorkingDir.replace(baseDir, ''),
+  route: localWorkingDir.replace(baseDir, '').replace(/\\/, '/'),


comment that this is for windows compatibility, would be nice.

igor-dv added 10 commits September 15, 2017 20:10

Call bootstrap with node

20084c7

Remove the public dir content

8e3a18d

Add docs to the yarn workspaces

0797d3e

Add public dir to ignore list

609c33c

Add git commands for committing a new docs version

c16b83a

Move git scripts to build.js

8a9621d

Override public export with new version export

5e9e86f

Remove env variable with token from the package.json (I'll revoke it,…

3d45c1c

… I promise)

Remove public dir at the beginning + update version of the docs packa…

9959b8b

…ge.json

Remove _next dir before copying

9853b6a

igor-dv added ci: do not merge documentation in progress labels Sep 16, 2017

igor-dv assigned ndelangen and igor-dv Sep 16, 2017

igor-dv added 2 commits September 17, 2017 01:02

Minor new line cleanup

c6b28fd

Fix typo

afcde5f

igor-dv added a commit that referenced this pull request Sep 17, 2017

Remove public dir - it will be ignored in #1855 - this will ease on CR.

be09070

igor-dv added 7 commits September 17, 2017 10:06

Merge remote-tracking branch 'origin/new-docs' into new-docs-versioning2

cdccf50

Merge remote-tracking branch 'origin/new-docs' into new-docs-versioning2

5edd1bd

# Conflicts: # docs-v2/package.json

Delete _next dir right before copying to the outputDir

635a299

Refactor build to chain of commands

dd77eb6

Use cross-env for setting NODE_ENV=production in the "next" related s…

26337e3

…cripts

💩, I did it again..

f41dc87

Try to ignore docs in the build-packs command

42687e6

igor-dv added the feature request label Sep 17, 2017

igor-dv added 3 commits September 17, 2017 13:57

Make sitemap generation windows friendly

7b2990e

Add version-aware link component

c95265b

Move everything from version _next dir to the main _next dir

d9b5d9a

Remove ASSET_PREFIX it's not needed

0f5010d

ndelangen reviewed Sep 18, 2017

View reviewed changes

ndelangen approved these changes Sep 18, 2017

View reviewed changes

igor-dv added 7 commits September 18, 2017 18:11

Remove verbose parameter from the git commands - there is a secret th…

7a1e834

…at might be printed.

Add docs-v2 to CI

d970c6d

Add git user config + temp remove CI steps

1b24fad

Revert the CI jobs removal + remove the docs-v2 for now - it needs a …

632193c

…better strategy than just publishing docs to the repo on every build in CI.

Delete old _next files according to the stored reference

c4f5233

Move promisifyProcess to a separate script and make the build more re…

cc678a5

…adable

Generate versions.json

c4f5c73

igor-dv removed ci: do not merge in progress labels Sep 19, 2017

ndelangen approved these changes Sep 19, 2017

View reviewed changes

igor-dv added 2 commits September 19, 2017 14:26

Add comments about windows support

cb3dc9b

Add docs-v2 to be deployed only on master

2236896

igor-dv merged commit a7dfa57 into new-docs Sep 19, 2017

igor-dv deleted the new-docs-versioning2 branch September 19, 2017 11:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New docs versioning - repo proposal #1855

New docs versioning - repo proposal #1855

igor-dv commented Sep 16, 2017 •

edited

Loading

codecov bot commented Sep 17, 2017 •

edited

Loading

ndelangen Sep 18, 2017

igor-dv Sep 18, 2017 •

edited

Loading

ndelangen Sep 19, 2017

igor-dv Sep 19, 2017

ndelangen Sep 18, 2017

codecov-io commented Sep 18, 2017 •

edited by codecov bot

Loading

ndelangen Sep 19, 2017

igor-dv Sep 19, 2017

ndelangen Sep 20, 2017

ndelangen Sep 19, 2017

ndelangen Sep 19, 2017

igor-dv Sep 19, 2017


		const versionRegex = [/^\/([0-9]+-[0-9]+-[0-9]+)\//, /^\/([0-9]+-[0-9]+-[0-9]+)$/];

		function getVersionHref(path, href) {

New docs versioning - repo proposal #1855

New docs versioning - repo proposal #1855

Conversation

igor-dv commented Sep 16, 2017 • edited Loading

What I did

Tasks TBD

Example

How to test

codecov bot commented Sep 17, 2017 • edited Loading

Codecov Report

Choose a reason for hiding this comment

igor-dv Sep 18, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Sep 18, 2017 • edited by codecov bot Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

igor-dv commented Sep 16, 2017 •

edited

Loading

codecov bot commented Sep 17, 2017 •

edited

Loading

igor-dv Sep 18, 2017 •

edited

Loading

codecov-io commented Sep 18, 2017 •

edited by codecov bot

Loading