Website: fix version display #582

DanielMSchmidt · 2018-02-23T08:06:46Z

This PR has two different aspects, one is "releasing" the 7.X version of the docs.
The other one is having a versions page so that when you click on the current version on the top left. Here is a video of this:

rotemmiz · 2018-03-04T09:32:47Z

I want to discuss doc duplication with you. I feel uncomfortable duping all docs 3 times (and potentially even more in the future). can't we generate the docs per version via git tags only on gh-pages branch during build ?

DanielMSchmidt · 2018-03-06T06:52:59Z

.travis.yml

@@ -52,6 +52,12 @@ matrix:

    # Website
    - language: node_js
+      addons:


This is needed by nodegit

DanielMSchmidt · 2018-03-06T07:31:51Z

@rotemmiz I thought you were not sure about storing them there, I didn't understand earlier that this is really a problem for you.

The way I solved it now is by getting every git tag above version 6 (where we changed the docs to support docusaurus) and generate the version for each doc in a temporary copy of this repo, which is then copied over.

This is currently WIP, the sidebars don't work in the current implementation, need to figure out what's going wrong there 🤔

Is this the general direction you want to go with this or did I misunderstand you? 😇

DanielMSchmidt · 2018-04-13T18:57:51Z

@rotemmiz This is done now / ready for review.

I would like to move the code upstream to docusaurus, I think it is a better place for it. Easier to test and be concise this way (changing docusaurus versions could break this current workflow if they change something severe in the way they deal with versions). This is the issue I created for it: facebook/docusaurus#557

rotemmiz · 2018-04-25T19:43:47Z

website/gatherDocs.js

+  });
+}
+
+function getMajorVersion(tag) {


Please use 'semver' instead of parsing versions manually, this will break the pretty easily

Good idea 👍

I fixed that @rotemmiz 👍 Please review again!

DanielMSchmidt · 2018-04-28T06:53:56Z

@rotemmiz This is ready now 👍 I only clone the repo once and execute every action on this copy now :)

rotemmiz

Great PR!
Have very few small notes.

rotemmiz · 2018-05-03T08:46:21Z

website/gatherDocs.js

+  await repo.checkoutBranch(version);
+}
+
+function applyTemporalFix(tempDir) {


applyMissingDocHeadersForV6 or whatever version which needs it.

rotemmiz · 2018-05-03T08:49:15Z

website/pages/en/versions.js

@@ -0,0 +1,90 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.


Is this Facebook's code ?
If not, remove the license note

It's generated by docusaurus, should I remove this part?

rotemmiz · 2018-05-03T08:51:20Z

website/pages/en/versions.js

+
+function VersionLinks({version, isLatest = false}) {
+  const expandedVersion = version.replace('.X', '.0.0')
+  const isMaster = version === "master";


Not sure I get what the final result will be. Will site show exact version (i.e. 7.3.5) or 7.0.0 throughout links ?

Video shows 7.X, 6.X and master. what am I missing ?

Video is old, but you can run it locally. Just do cd website/ && npm install && npm run gatherDocs && npm start and you can see the site

rotemmiz · 2018-05-03T08:52:58Z

website/versioned_docs/version-6.X/APIRef.ActionsOnElement.md

@@ -1,110 +0,0 @@
---


<3<3<3<3<3<3<3<3<3<3<3<3<3<3

DanielMSchmidt · 2018-05-03T20:52:36Z

Damn it, the checkout seems to have failed, unnoticed by me. Need to do some more node-git magic here.

DanielMSchmidt · 2018-05-04T05:49:02Z

@rotemmiz I think I got your review comments, please take a look 👍

rotemmiz · 2018-05-04T06:01:13Z

website/gatherDocs.js

+}
+
+// https://stackoverflow.com/questions/29569913/switch-branch-tag-with-nodegit?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
+function checkOutTag(repo, tag) {


LOL, utm_source will provide false data for trackers next time someone opens this link ;p
JK, but the query string can be removed

Right, I'll get rid of that and see if I can get a better permalink

DanielMSchmidt · 2018-05-08T15:32:40Z

@rotemmiz Got a spare review?

DanielMSchmidt requested review from LeoNatan and rotemmiz as code owners March 5, 2018 08:22

DanielMSchmidt force-pushed the website/versions branch 3 times, most recently from 517b7ff to 76e8698 Compare March 5, 2018 22:07

DanielMSchmidt commented Mar 6, 2018

View reviewed changes

.travis.yml

@@ -52,6 +52,12 @@ matrix:

# Website

- language: node_js

addons:

Copy link

Contributor Author

DanielMSchmidt Mar 6, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is needed by nodegit

DanielMSchmidt changed the title ~~Website: fix version display~~ [WIP] Website: fix version display Mar 7, 2018

DanielMSchmidt force-pushed the website/versions branch 2 times, most recently from 74e6108 to 584faa3 Compare March 8, 2018 19:38

DanielMSchmidt force-pushed the website/versions branch 2 times, most recently from 5e3ff4d to 1df93a1 Compare April 13, 2018 18:31

DanielMSchmidt changed the title ~~[WIP] Website: fix version display~~ Website: fix version display Apr 13, 2018

DanielMSchmidt force-pushed the website/versions branch from 1df93a1 to 9307cb7 Compare April 13, 2018 18:35

DanielMSchmidt mentioned this pull request Apr 13, 2018

Use git tags for versioning facebook/docusaurus#557

Closed

DanielMSchmidt force-pushed the website/versions branch from 9307cb7 to c472253 Compare April 24, 2018 19:14

rotemmiz reviewed Apr 25, 2018

View reviewed changes

DanielMSchmidt self-assigned this Apr 25, 2018

DanielMSchmidt added 4 commits April 28, 2018 07:53

show version overview

5668269

add documentation for release 7.X

b06bc48

Gather doc versions from git tags

bf25220

refactor semver parsing

cc2b436

DanielMSchmidt force-pushed the website/versions branch from e7c2773 to cc2b436 Compare April 28, 2018 05:53

Daniel Schmidt added 2 commits April 28, 2018 08:26

refactor gathering documents functionality into smaller chunks

056027f

only clone the repository once instead of multiple times

87e4019

rotemmiz reviewed May 3, 2018

View reviewed changes

DanielMSchmidt added 3 commits May 4, 2018 07:43

fix checkout process

a0d2cd3

only apply fix when needed

cade110

remove autogenerated fragment

52dab87

rotemmiz reviewed May 4, 2018

View reviewed changes

fix link to stackoverflow snippet

70e8de1

rotemmiz merged commit 6cf3963 into master May 8, 2018

wix locked and limited conversation to collaborators Jul 23, 2018

LeoNatan deleted the website/versions branch July 22, 2019 02:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Website: fix version display #582

Website: fix version display #582

DanielMSchmidt commented Feb 23, 2018

rotemmiz commented Mar 4, 2018

DanielMSchmidt Mar 6, 2018

DanielMSchmidt commented Mar 6, 2018

DanielMSchmidt commented Apr 13, 2018

rotemmiz Apr 25, 2018

DanielMSchmidt Apr 25, 2018

DanielMSchmidt Apr 25, 2018

DanielMSchmidt commented Apr 28, 2018

rotemmiz left a comment

rotemmiz May 3, 2018

rotemmiz May 3, 2018

DanielMSchmidt May 3, 2018

rotemmiz May 3, 2018

rotemmiz May 3, 2018

DanielMSchmidt May 3, 2018

rotemmiz May 3, 2018

DanielMSchmidt commented May 3, 2018

DanielMSchmidt commented May 4, 2018

rotemmiz May 4, 2018

DanielMSchmidt May 4, 2018

DanielMSchmidt commented May 8, 2018

		@@ -0,0 +1,90 @@
		/**
		* Copyright (c) 2017-present, Facebook, Inc.

Website: fix version display #582

Website: fix version display #582

Conversation

DanielMSchmidt commented Feb 23, 2018

rotemmiz commented Mar 4, 2018

Choose a reason for hiding this comment

DanielMSchmidt commented Mar 6, 2018

DanielMSchmidt commented Apr 13, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DanielMSchmidt commented Apr 28, 2018

rotemmiz left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DanielMSchmidt commented May 3, 2018

DanielMSchmidt commented May 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DanielMSchmidt commented May 8, 2018