Data files from docs.cask.co #2

awholegunch · 2016-11-10T03:24:09Z

#New file is docs.cask.co/www/resources/scripts/redirect-page.js
Modified file is docs.cask.co/www/404.html which has been changed to use it

The redirect page and the modified 404 are to address https://issues.cask.co/browse/INFRA-31
The Error Document for the bucket is (and should be) set to this modified 404.html page.

Results at http://builds.cask.co/browse/DOC-SITE0-19/artifact

New file is docs.cask.co/www/resources/scripts/redirect-page.js Modified file is docs.cask.co/www/404.html which has been changed to use it

wolf31o2

A few minor changes, and a request to reduce duplication. Do we need multiple copies of jquery.js or the cask_404_75pc.png file? Can they not just go under /resources and all the docs that are on the site use them?

wolf31o2 · 2016-11-10T16:25:48Z

docs.cask.co/www/404.html

+    j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+    '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,'script','dataLayer','GTM-KWLFGH');</script>
+    <!-- Google Tag Manager end -->


Isn't this block stored in another file we can include, instead?

Thought this block is included in just about all of our files, I don't know if it can be separate. Looking at Google's docs, they never suggest including it that way. It might have something to do with latency and the asynchronous nature of that code block; it might need to be directly in the page rather than in a separate file. This was included following their directions.

OK. For some reason I was thinking that it was included in our docs, not in-line, but I think I am just mistaken.

No, you're not mistaken: it is included in our docs. But there it is the template file that Sphinx then uses to build the documentation. So each HTML page it as it is here. It is included in ~/Source/cdap/cdap-docs/_common/_themes/cdap/layout.html.

wolf31o2 · 2016-11-10T17:26:13Z

docs.cask.co/www/404.html

+    </script>
+    <script type="text/javascript" src="cdap/current/en/_static/jquery.js"></script>
+    <script type="text/javascript" src="cdap/current/en/_static/underscore.js"></script>
+    <script type="text/javascript" src="cdap/current/en/_static/doctools.js"></script>


Should any of this be at the root level? Maybe under resources/scripts? Seems like yes, to me.

I've made copies of these in the resources directory, and linked to them in the upper-level files as appropriate. There are still copies in the current directories, as per the comment below.

wolf31o2 · 2016-11-10T17:32:41Z

docs.cask.co/www/resources/scripts/redirect-page.js

+ */
+
+(function() {
+  var products = new Array( "cdap", "coopr", "tigon" );


Can we read this list from a file that we generate? This could be generated by the TYPES list that gets run in the build.

The browser wouldn't be able to read the file, but we could generate this file (redirect-page.js) dynamically. I've added that to the build.sh script.

awholegunch · 2016-11-14T21:02:53Z

You asked:
Do we need multiple copies of jquery.js or the cask_404_75pc.png file? Can they not just go under /resources and all the docs that are on the site use them?
Short answer: We need the multiple copies.
Long answer: Each doc set is independent. They are designed to be zipped and then downloaded locally for local use. So each current needs its own copy. They may also change over time, if I ever get around to updating them.

As for the 404 images: they will probably go, but until we have a working deployment on S3 and I can check how the 404 redirects are working, I would like to leave them, and delete them when that is changed.

directory. Added generation of the redirect-page.js from the different configuration types. Updated the HTML pages and the favicon.ico files. Updated README file with warning about the Bamboo error.

wolf31o2

After this last set of changes, it 👍 LGTM

wolf31o2 · 2016-11-15T00:02:20Z

docs.cask.co/scripts/build.sh

 for __type in ${__types}; do
+  __types_array+=", \"${__type}\""


This isn't an array. It's confusing. Also, you're doing this in the loop, where it doesn't make sense. You already have the complete list, with ${types}, so just use that...

wolf31o2 · 2016-11-15T00:15:16Z

docs.cask.co/scripts/build.sh

      echo "Could not create 'json-versions.js' and 'version' file for ${__type}" ; exit 1)
 done
+
+sed -e "s|TYPE_ARRAY|${__types_array:1}|" "${__site}/www/resources/redirect-page.js" > "${__site}/target/www/resources/redirect-page.js"  || ( echo "Could not rewrite redirect-page.js to target directory" ; exit 1)


sed -e "s|TYPE_ARRAY|$(echo ${types} | sed -e 's#^#"#' -e 's# #" "#g' -e 's#$#"#' -e 's# #, #g')|" ...

Also, that exit won't exit. It'll exit the subshell that you spawned. Instead, remove the || and use:

__ret=$? [[ ${__ret} -ne 0 ]] && echo "..." exit ${__ret}

$ cat page.js var something=( TYPE_ARRAY ); sed -e "s|TYPE_ARRAY|$(echo ${types} | sed -e 's#^#"#' -e 's# #" "#g' -e 's#$#"#' -e 's# #, #g')|" page.js var something=( "cdap", "coopr", "tigon" );

Changed. Note that the above needs to be $(echo ${__types}…

wolf31o2 · 2016-11-15T00:16:45Z

docs.cask.co/www/404.html

+    j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+    '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,'script','dataLayer','GTM-KWLFGH');</script>
+    <!-- Google Tag Manager end -->


OK. For some reason I was thinking that it was included in our docs, not in-line, but I think I am just mistaken.

wolf31o2 · 2016-11-15T00:21:18Z

docs.cask.co/README.rst

@@ -30,6 +30,8 @@ as they are copies used to test the menus when the configuration file has been g
 The build script (see below) copies the contents of ``www`` to the ``target`` directory when
 it is run.

+**Note:** Due to https://jira.atlassian.com/browse/BAM-18015, we do not use any sub-directories
+in the ``resources`` directory.


Is this necessary? This seems like it would belong in a design doc, or as a comment in a file, not in the main README. I'd remove it.

This README is the design doc for this; we don't have one elsewhere. I wanted to make this prominent, so people won't forget.

in "current" directories for product-specific 404 and index pages.

…ction.

Break lines shorter.

wolf31o2 · 2016-11-18T20:40:34Z

👍 LGTM

Data files from docs.cask.co

245b973

New file is docs.cask.co/www/resources/scripts/redirect-page.js Modified file is docs.cask.co/www/404.html which has been changed to use it

awholegunch added enhancement On-hold labels Nov 10, 2016

Handle directories above the numbered versions.

b3dae89

awholegunch removed the On-hold label Nov 10, 2016

Fix titles.

22a326f

wolf31o2 suggested changes Nov 10, 2016

View reviewed changes

John Jackson added 4 commits November 10, 2016 10:10

Change index files to disable them.

9b1aa60

Update case of references.

fbd35f4

Change to having an internal www directory inside the target directory.

722d6b1

Throw in a zip for yucks.

13f203f

Consolidate the resources scripts and images into a single resources

c85a486

directory. Added generation of the redirect-page.js from the different configuration types. Updated the HTML pages and the favicon.ico files. Updated README file with warning about the Bamboo error.

wolf31o2 suggested changes Nov 15, 2016

View reviewed changes

John Jackson added 7 commits November 14, 2016 16:29

Fix broken links. Change cdap.css to cask.css, and use the version

2bba388

in "current" directories for product-specific 404 and index pages.

Fix sidebar links.

dbf27d6

Remove emphasis in sidebar links as it is not being used.

02c03ed

Change per comment.

7891bf5

Oops. Forgot to grab the return code.

6b7d55d

Add Google Tag Manager "no script" codes to the top of each <body> se…

8cb1f04

…ction.

Add a die function, and use to exit on failures.

2512328

Break lines shorter.

wolf31o2 approved these changes Nov 18, 2016

View reviewed changes

awholegunch merged commit 8e86451 into develop Nov 18, 2016

awholegunch deleted the feature/docs-site-data branch November 18, 2016 22:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Data files from docs.cask.co #2

Data files from docs.cask.co #2

awholegunch commented Nov 10, 2016 •

edited

Loading

wolf31o2 left a comment

wolf31o2 Nov 10, 2016

awholegunch Nov 14, 2016

wolf31o2 Nov 15, 2016

awholegunch Nov 15, 2016

wolf31o2 Nov 10, 2016

awholegunch Nov 14, 2016

wolf31o2 Nov 10, 2016

awholegunch Nov 14, 2016

awholegunch commented Nov 14, 2016

wolf31o2 left a comment

wolf31o2 Nov 15, 2016

wolf31o2 Nov 15, 2016

wolf31o2 Nov 15, 2016

awholegunch Nov 15, 2016

wolf31o2 Nov 15, 2016

wolf31o2 Nov 15, 2016

awholegunch Nov 15, 2016

wolf31o2 commented Nov 18, 2016

		for __type in ${__types}; do
		__types_array+=", \"${__type}\""

Data files from docs.cask.co #2

Data files from docs.cask.co #2

Conversation

awholegunch commented Nov 10, 2016 • edited Loading

wolf31o2 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

Choose a reason for hiding this comment

awholegunch commented Nov 14, 2016

wolf31o2 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

wolf31o2 commented Nov 18, 2016

awholegunch commented Nov 10, 2016 •

edited

Loading