FLUID-6506: Migrated from Docpad to 11ty for GSoC 2020 #56

sachin10101998 · 2020-05-28T01:07:56Z

GSoC 2020 Project

BlueSlug

Looking great. I'm excited to see this in action!

It needs a few changes before I'd be comfortable with it being merged in, but it's very close already.

.gitignore

AUTHORS.md

Gruntfile.js

README.md

src/filters/w3-date-filter.js

src/posts/2007-05-04-Better_Web_Experiences.md

Gruntfile.js

src/projects.html

BlueSlug · 2020-05-29T04:06:48Z

I also noticed that the spacing of elements differs between the live version running at https://fluidproject.org/ and the version I built locally. It would be good to know what's going on there, as the output should be identical (except for UIO which has been updated). It's subtle, but would be more apparent if you open these two sites and switch back and forth between them.

The live (DocPad) version:

The dev (11ty) version:

src/_includes/partials/header.html

jhung · 2020-05-29T18:36:10Z

There's a bug where loading the root of the site (i.e. localhost:9778/) incorrectly sets News as the current navigation item, but should be Home.

Loading the site using localhost:9778/index.html does not cause this problem.

jhung · 2020-05-29T19:02:11Z

The Infusion directory src/lib/infusion is being tracked, but I wonder if this is necessary or desired since the contents of that directory is copied from ./node_modules/infusion/dist/. @BlueSlug thoughts?

sachin10101998 · 2020-05-29T19:40:53Z

@jhung @BlueSlug I fixed that bug where the default page showed news as highlighted or selected page. I've also removed the package lock json file and pinned dependencies in package.json file. Can we merge it now?

README.md

BlueSlug · 2020-06-05T14:31:20Z

The Infusion directory src/lib/infusion is being tracked, but I wonder if this is necessary or desired since the contents of that directory is copied from ./node_modules/infusion/dist/. @BlueSlug thoughts?

If Infusion is being pulled in via npm, then I agree that it isn't necessary to track this directory unless it's required for the build process.

package.json

BlueSlug

Looking pretty good, though there are still many changes that need to be made before I'm comfortable giving my approval for merging.

Beyond what's noted in individual files:

The linter is failing. Please be sure to lint the repo before every commit. I often forget this, so I use a git pre-commit hook that does it automatically. You can use this one if you like: https://raw.githubusercontent.com/fluid-project/sjrk-story-telling/master/pre-commit
There are still styling & spacing inconsistencies between this site and the live site. Please look into this, since it should be a direct 1:1 port of the old site
I recommend checking out GitHub's Markdown guide for some tips on Markdown formatting
The two layout files default.html and posts.html are 99% identical. Consider ways to remove this duplication
Please make sure all JavaScript files that are original to this repo have the copyright notice in them. The one in Gruntfile.js is perfect except for the dates (the date should only be in AUTHORS.md)
Is .nojekyll necessary? I think it can safely be removed
analytics.js is empty. Please either remove it or add code to it
There are many references to "FLOE" that should be "Fluid". I also often get tripped up doing copy-paste from other code, so it's important to be wary of this sort of thing :)

CONTRIBUTING.md

src/_includes/partials/header.html

src/posts/2009-08-12-Fluid_Infusion_1_1_1_released.md

sachin10101998 · 2020-06-06T06:13:41Z

@BlueSlug
I have addressed all the review comments and made the changes as required.

nojekyll file has been removed
Added code to analytics.js as prescribed by Gtirloni
Made all conversions from floe to fluid.
Added the right copyright template to all original JS files.
default.html and post.html are almost identical but when I try to merge them, infusion uio breaks for some reason unknown and it doesn't work and console shows errors. I have tried all methods to combine them but until and unless they are in different formats with different names, infusion breaks. Hence I kept them separate.
The inconsistency in the live site and migrated site is due to the fact that I changed the UIO preferences in order to keep it in sync with floe project. It made no sense to have different stylings for the same thing and a consistent style for the uio button provided with consistency. Sue to different shapes of the button, the site shifts a bit low compared to the original site, but the migrated site is in accordance with floe project.
Markdown inconsistencies are being caused due to usage of HTML tags in the MD files. These HTML tags come from the original news articles. i really don't know how to go around this. We can either remove the posts folder from markdown linting or we'll have to rewrite those posts in accordance with markdown supported tags.

sachin10101998 · 2020-08-05T16:10:07Z

@BlueSlug I found a workaround to deal with styling while keeping all the posts in markdown. I have made the required changes in both floe and fluid. Please check.

BlueSlug

It's looking really great! The Markdown files are nearly perfect now, just a handful of formatting issues but nothing too complicated :)

BlueSlug · 2020-08-07T21:17:44Z

src/_includes/layouts/default.html

+<!doctype html>
+<html lang="en" dir="ltr">
+    <head>
+        <title>{% if title %} {{ title }} {% else %} {{ site.title }} {% endif %}</title>


Please add | fluid at the end of the title, since every page on the current site has this as well

BlueSlug · 2020-08-07T21:17:58Z

src/_includes/layouts/newsindex.html

+<!doctype html>
+<html lang="en" dir="ltr">
+    <head>
+        <title>{% if title %} {{ title }} {% else %} {{ site.title }} {% endif %}</title>


Please add | fluid at the end of the title, since every page on the current site has this as well

(E.g. the News page on the current site has the title News Archive | fluid, whereas the current version of the 11ty site has News)

BlueSlug · 2020-08-07T21:18:05Z

src/_includes/layouts/post.html

+<!doctype html>
+<html lang="en" dir="ltr">
+    <head>
+        <title>{% if title %} {{ title }} {% else %} {{ site.title }} {% endif %}</title>


Please add | fluid at the end of the title, since every page on the current site has this as well

BlueSlug · 2020-08-07T21:33:18Z

src/index.html

@@ -0,0 +1,45 @@
+---
+layout: layouts/default
+title: The Open Source Software Community - Fluid Project


Please remove - Fluid Project from the end of this line

BlueSlug · 2020-08-07T21:34:39Z

src/infusion.html

+---
+layout: layouts/default
+permalink: infusion.html
+title: Infusion | fluid


Please remove | fluid from the title of this page (since it should be added to the layout template)

BlueSlug · 2020-08-07T23:11:20Z

src/posts/2008-06-02-Fluid_Infusion_v0_3_released.md

+author: Release Manager
+---
+**The Fluid Project is pleased to announce the release of Fluid Infusionv0.3, the latest release of the**
+**Fluid  component library and User Experience (UX) Toolkit.


Please remove the ** at the beginning of this line and add it at the end, the whole paragraph is meant to be bold.

BlueSlug · 2020-08-07T23:12:52Z

src/posts/2007-12-01-Fluid 0_1_is_Here.md

+
+### What&#39;s New in This Release?</h3>
+
+- The Reorderer, a JavaScript library for sorting DOM elements ###


Please remove the ### from the end of this line and the four lines after it

BlueSlug · 2020-08-07T23:13:07Z

src/posts/2007-12-01-Fluid 0_1_is_Here.md

+Fluid is still in early development, and this release has a number of  known issues. API changes will be coming
+in the future, so for now, we  encourage you to use 0.1 for experimentation and prototyping. Check the
+README.txt file in the download package for a list of known issues.
+Thanks to everyone in the community for their hard work on this release!


Please add an extra line break before this line, this is meant to be two paragraphs

BlueSlug · 2020-08-07T23:14:36Z

src/posts/2007-12-01-Fluid 0_1_is_Here.md

+The Fluid Project is pleased to announce the first release of the Fluid component library and
+User Experience (UX) Toolkit.
+
+### What&#39;s New in This Release?</h3>


Please remove all instances of </h3> from this file. Search-and-replace can often lead to leftover bits of markup like this, it's important to check afterwards :)

BlueSlug · 2020-08-07T23:17:33Z

Gruntfile.js

+            sources: {
+                json: ["package.json", ".eslintrc.json","./src/_data/*.json"],
+                js: ["./src/assets/js/*.js","./src/transforms/*.js","./src/filters/*.js","./src/assets/js/*.js","./src/filters/*.js","./src/utils/*.js",".eleventy.js","Gruntfile.js"],
+                md: ["./src/posts/*.md"]


Please include all other Markdown files in the project in the md linter (README.md, AUTHORS.md, CONTRIBUTING.md, etc.), except for the news post template and anything in the lib directory

Added README.md, AUTHORS.md, CONTRIBUTING.md, etc.. The lib folder is not added because it's being copied from infusion and we lint only third party files. We discussed this earlier and came to a conclusion that this folder does not need to be linted. Therefore, I didn't add it.

Great, thanks!

Other files that I would suggest adding to this list, other than the three you just mentioned, would be:

./_data/README.md

./.github/ISSUE_TEMPLATE/bug_report.md

./.github/ISSUE_TEMPLATE/feature_request.md

and maybe ./src/assets/stylesheets/foundation/README.md since it's not copied in as a 3rd-party file, but I'm less concerned about that one.

BlueSlug

It's looking nearly ready to merge! Excellent work @sachin10101998 👍

The only things I would like to see before giving my approval for merging are what we discussed in our video call yesterday:

output news files should be placed in the news dir and files should have the same filenames as the current site (so no outside links to the Fluid Project site get broken)
implement the slug field in the front matter and use that for the output filename if it's present, falling back to title if not
as @jhung suggested in this comment, it would be better if the startup script was called start instead of eleventyport, since the name is unexpected compared to our other projects, and that it would include a new clean script before building

sachin10101998 · 2020-08-12T19:47:16Z

@BlueSlug I have made all the required changes. Also, the timezone difference bug won't happen now as I removed that filter. it was not needed.

BlueSlug

I feel this is ready to be merged in. @jhung has agreed to provide a final review, but if any other fluid-project committers would like to, it would be welcome :)

I have also filed a small PR against @sachin10101998's branch which tidies up CONTRIBUTING.md a little bit, but I don't think this is critical to solve ahead of merging.

@gtirloni: is there anything that should be added for deployment to work properly once this is merged in? There are already the files you added to build the image and push it to Docker Hub, of course.

gtirloni · 2020-08-18T11:17:58Z

@gtirloni: is there anything that should be added for deployment to work properly once this is merged in? There are already the files you added to build the image and push it to Docker Hub, of course.

I'll need to configure the servers to properly deploy this and the changes aren't very simple. I'd prefer to work on this in a separate PR, if that's okay.

Clarified instructions for running project locally

BlueSlug · 2020-08-18T18:01:00Z

@gtirloni: I have no objection to that being covered in a separate PR as long as merging this into fluid-project/master won't impact the deployed site :)

gtirloni · 2020-08-18T18:26:16Z

@BlueSlug excellent point! I've disabled the existing Jenkins jobs for the fluid and floe websites so it won't deploy anything. Thanks!

jhung · 2020-08-18T17:38:12Z

README.md


 1. Get the required node modules: `npm install`
-2. Run docpad from the fluid-website directory `npm run docpad`.
-3. Open `http://localhost:9778/` to see the website. 
+2. Run [11ty](http://11ty.dev) from the fluid-website directory `npm run eleventyport`.


This needs to be updated with npm run start

jhung · 2020-08-24T17:37:44Z

CONTRIBUTING.md

+      `layout: layouts/post`
+      `title: Title of News Article`
+      `date: 'YYYY-MM-DD'`
+      `tags: post`


If tags are not being used, then it should be removed from the template.

jhung · 2020-08-24T17:43:30Z

CONTRIBUTING.md

+      `permalink: YYYY-MM-DD-newsArticleName.html`
+      `filename: Short URL for news. May contain Capital Items but no spaces`


It's confusing to have both permalink and filename. The permalink should be removed since it is automatically generated from the {date}-{title}.html.

jhung · 2020-08-24T18:12:14Z

package.json

+        "lint": "grunt lint",
+        "clean": "rimraf dist",
+        "cleandependencies": "rimraf node_modules",
+        "cleanall": "rimraf node_modules && rimraf dist"


I can not seem to successfully run cleanall. To reproduce:

Run npm i then npm run build

Run npm run cleanall
The following would appear in the error log:

13 verbose stack Error: fluidproject.org@1.0.0 cleanall: `rimraf node_modules && rimraf dist` 13 verbose stack Exit status 1 13 verbose stack at EventEmitter.<anonymous> (C:\Users\jhung\AppData\Roaming\npm\node_modules\npm\node_modules\npm-lifecycle\index.js:332:16) 13 verbose stack at EventEmitter.emit (events.js:223:5) 13 verbose stack at ChildProcess.<anonymous> (C:\Users\jhung\AppData\Roaming\npm\node_modules\npm\node_modules\npm-lifecycle\lib\spawn.js:55:14) 13 verbose stack at ChildProcess.emit (events.js:223:5) 13 verbose stack at maybeClose (internal/child_process.js:1021:16) 13 verbose stack at Process.ChildProcess._handle.onexit (internal/child_process.js:283:5)

I recreated the scenario and I do not see this error.

Thanks for testing. I've filed an issue (#61 ) so it can be investigated later.

…ject.org into eleventy

jhung

Looks good!

jhung · 2020-08-24T19:14:07Z

@gtirloni This PR is now ready for deploy testing. Let me know what the next steps are.

gtirloni · 2020-08-24T19:37:43Z

@gtirloni This PR is now ready for deploy testing. Let me know what the next steps are.

Thanks! I'll start working on that tomorrow morning.

sachin10101998 added 3 commits May 28, 2020 06:33

Migrated from Docpad to 11ty for GSoC 2020

1b738cd

Added nojekyll file

765e5f0

Removed old blog posts

a238c7c

BlueSlug requested changes May 29, 2020

View reviewed changes

BlueSlug reviewed May 29, 2020

View reviewed changes

src/_includes/partials/header.html Outdated Show resolved Hide resolved

sachin10101998 added 3 commits May 29, 2020 15:22

Fixed indentation in html files and updated README files

2d95875

Fixed indentation in news posts

85592cd

Fixed active nav link css

b816af4

Removed package lock json file and fixed Nav link default CSS

650e0f7

sachin10101998 added 4 commits May 30, 2020 01:12

Deleted package json lock file

5fa11b3

Added contributing.md file

eefbeec

Updated Contributing.md file

d55c3f3

Added Analytics code

7d01dbf

gtirloni reviewed Jun 5, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

gtirloni reviewed Jun 5, 2020

View reviewed changes

package.json Outdated Show resolved Hide resolved

BlueSlug requested changes Jun 5, 2020

View reviewed changes

sachin10101998 added 5 commits June 6, 2020 08:43

Fixed npm run build script in Readme.md

d00cc63

Fixed typo in README.md

5bbdbf3

Updated contributing.md file and removed nojekyll file

d2119b2

Updated Readme.md file

e658c47

Fixed inconsistencies

26e7237

gtirloni added 3 commits June 16, 2020 12:56

Fix conflict

797e928

Fix conflicts

d99f105

FLUID-6506 Update Dockerfile for 11ty

bfc93c1

Fix linter warnings

12c756a

BlueSlug requested changes Aug 7, 2020

View reviewed changes

sachin10101998 added 3 commits August 8, 2020 23:56

Added fluid to title and linter for markdown files in root

c28e0f4

Minor fixes

a7e8456

Fixed nested list indentation

c22fe47

BlueSlug reviewed Aug 11, 2020

View reviewed changes

sachin10101998 added 3 commits August 12, 2020 22:49

Updated npm scripts

bbfa51d

Fixed permalinks

749642b

Updated CONTRIBUTING.md

2e44542

sachin10101998 and others added 6 commits August 13, 2020 01:35

Minor changes

aabba6c

Updated README.md

26565c7

Updated CONTRIBUTNG.md

b0efd6e

Updated CONTRIBUTNG.md

3df8d8e

Clarified instructions for running project locally

bdd7c31

Removed unnecessary creation of template file in output directory

950872d

BlueSlug approved these changes Aug 17, 2020

View reviewed changes

Merge pull request #2 from BlueSlug/patch-1

78cca46

Clarified instructions for running project locally

jhung requested changes Aug 24, 2020

View reviewed changes

sachin10101998 added 2 commits August 25, 2020 00:02

Fixed READme and contributing.md document

870302f

Merge branch 'eleventy' of https://github.com/sachin10101998/fluidpro…

7474a0c

…ject.org into eleventy

jhung mentioned this pull request Aug 24, 2020

cleanall script fails on Windows #61

Closed

jhung approved these changes Aug 24, 2020

View reviewed changes

jhung merged commit 772f263 into fluid-project:master Aug 24, 2020


		### What's New in This Release?</h3>

		- The Reorderer, a JavaScript library for sorting DOM elements ###

		`permalink: YYYY-MM-DD-newsArticleName.html`
		`filename: Short URL for news. May contain Capital Items but no spaces`

FLUID-6506: Migrated from Docpad to 11ty for GSoC 2020 #56

FLUID-6506: Migrated from Docpad to 11ty for GSoC 2020 #56

Conversation

sachin10101998 commented May 28, 2020

BlueSlug left a comment

Choose a reason for hiding this comment

BlueSlug commented May 29, 2020

jhung commented May 29, 2020

jhung commented May 29, 2020

sachin10101998 commented May 29, 2020 • edited

BlueSlug commented Jun 5, 2020

BlueSlug left a comment

Choose a reason for hiding this comment

sachin10101998 commented Jun 6, 2020 • edited

sachin10101998 commented Aug 5, 2020

BlueSlug 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sachin10101998 Aug 8, 2020 • edited

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

Choose a reason for hiding this comment

BlueSlug left a comment

Choose a reason for hiding this comment

sachin10101998 commented Aug 12, 2020 • edited

BlueSlug left a comment

Choose a reason for hiding this comment

gtirloni commented Aug 18, 2020

BlueSlug commented Aug 18, 2020

gtirloni commented Aug 18, 2020

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

jhung left a comment

Choose a reason for hiding this comment

jhung commented Aug 24, 2020

gtirloni commented Aug 24, 2020

sachin10101998 commented May 29, 2020 •

edited

sachin10101998 commented Jun 6, 2020 •

edited

sachin10101998 Aug 8, 2020 •

edited

sachin10101998 commented Aug 12, 2020 •

edited