Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changing the Base of the gh-pages site. #893

Open
ConradSelig opened this issue Sep 18, 2018 · 21 comments
Open

Changing the Base of the gh-pages site. #893

ConradSelig opened this issue Sep 18, 2018 · 21 comments

Comments

@ConradSelig
Copy link
Contributor

ConradSelig commented Sep 18, 2018

After spending some time figuring out how the gh-page works, I made a few discoveries about why editing it has been so difficult - and why future edits at the site's current state would continue to be difficult.

First off, the content on the site is compiled from a .md (mark-down) file. Formatting mark-down to get it to look just right is complicated, and styling it to look like the app would be impossible as .css classes cannot be applied.

There is good news however, I have found a way to transfer the content to .html pages instead of .md pages. This means we can apply css, add images, include links, and much more - just like we do in the app.

Only problem here is that the structure of the site needs several big changes, so instead of just going ahead and making them, I'm looking for input and approval. If the change is made, the GitHub page would continue forward just like an .html page would.

Also a note to developers looking to make changes to the site, a local version can be run using Jekyll from Ruby. Here is the link I used to get it working for me: http://kbroman.org/simple_site/pages/local_test.html

@missyschoenbaum
Copy link
Contributor

Will we be rearranging all those items that are currently in the gh-page branch? If so, I can start on changing the links I think we will need this eventually, but let's keep the priority behind the bug fixes. Bottom line, yes, we will need this at some point in the future.

ConradSelig added a commit that referenced this issue Jan 29, 2019
Changing the github pages base from markdown to html. This includes two new folders, a _site_assets folder for developer editing, and a _site folder for the compiled site. Jekyll will build the _site folder - so don't edit anything in there. _config.yml was edited to support these changes.
ConradSelig added a commit that referenced this issue Jan 29, 2019
After the previous commit it became apparent that the site was still trying to use the old index.html and about.md. This edit to the _config.yml file should exclude those original files from the site build.
ConradSelig added a commit that referenced this issue Jan 29, 2019
Exclusion did not work, removing from _config.yml. Going to rename the old files in an attempt to remove them from the scope of Jekyll, this should force the site to use the _site files.
ConradSelig added a commit that referenced this issue Jan 29, 2019
…les"

This reverts commit 4f5ae9b and 4171817. This should reset the site to a location where it is still changeable.
ConradSelig added a commit that referenced this issue Jan 30, 2019
The github version of the site is not getting the html code from the same source as my local version of the site. These Gemfiles should fix that issue.
@missyschoenbaum
Copy link
Contributor

If you need something to post, here's the one page publicity flyer.
ADSM_OnePage_Info flyer_101518_USAHA.docx.pdf

ConradSelig added a commit that referenced this issue Jan 30, 2019
These files should be generated by Jekyll when the server compiles, but looking in the gh-pages repo, it doesnt seem they are being generated. Adding them manually may point Jekyll in the right direction when it goes to make the site live.
ConradSelig added a commit that referenced this issue Feb 2, 2019
It seems the online version of the site is using index.html as the base page instead of _site/index.html. This commit changes the root index.html to redirect to _site/index.html. This will remove all formatting that might have been saved from the original gh-pages setup, but will allow it to be far more customizable in the future.
@ConradSelig
Copy link
Contributor Author

Looks like the live version is actually using about.md as the base page, interesting! I'm now looking into a way to either redirect a markdown file to html or get the live version of the site to use index.html as the base page instead.

ConradSelig added a commit that referenced this issue Feb 2, 2019
I believe that jekyll is trying to use the _site files despite the fact that the live site cannot find those files (404). Hopefully by removing these config lines it will just use the root index.html
ConradSelig added a commit that referenced this issue Feb 2, 2019
Removing all files from failed attempts, this will keep the branch nice and clean so future developers don't get confused with what is going on when debugging.
@ConradSelig
Copy link
Contributor Author

That got it! Time to spend a bit of time formatting the website so it actually has content.

ConradSelig added a commit that referenced this issue Feb 3, 2019
No new content added (imported old content from about.md), just some simple formatting. More formatting to come in the near future.
ConradSelig added a commit that referenced this issue Feb 4, 2019
Added PDF databank, no PDF links currently added. All style changes conform to rules set in fontandcolorguide.pdf currently located in the gh-pages branch.
ConradSelig added a commit that referenced this issue Feb 4, 2019
Added more information to the left column. Also added more intelligent formatting so future changes to the two-column design will be less difficult.
@ConradSelig
Copy link
Contributor Author

This is ready for any content to be added.

@missyschoenbaum I'm going to leave you with this thread and add it to testing. I think if we leave it in development as long as we think there will be more content to add it will be in the development pipeline forever. I've sent you an email asking about what pdf files you want to add right away.

@missyschoenbaum
Copy link
Contributor

I posted the one page overview earlier in this issue. The text is about the same as the text that is posted, but it would let us try posting something.

@missyschoenbaum
Copy link
Contributor

First note - PDF databank wording becomes Reference Databank. Addtional Databanks for training and other languages can be added.

@missyschoenbaum
Copy link
Contributor

I have "Basicsofstochaticmodeling.pdf" ready to go up into the reference material. It is slightly different than the wiki, but close enough.

@ConradSelig
Copy link
Contributor Author

@missyschoenbaum Can you upload that "Basicsofstochaticmodeling.pdf" to the gh-pages fork? I see a "Basicsofstochaticmodeling.docx" but I'm not sure if that's the most updated version of the file or I would just convert it myself.

@missyschoenbaum
Copy link
Contributor

Did I put this in the wrong place?
ghpages

@ConradSelig
Copy link
Contributor Author

Nope, that's exactly where it should be. I've already got it linked into the Reference Databank.

@ConradSelig
Copy link
Contributor Author

@missyschoenbaum What else do you have for this ticket? General document requests probably don't belong in this thread.

@missyschoenbaum
Copy link
Contributor

Want to teach me where to add more? I just got another one cleaned up and moved up.

@ConradSelig
Copy link
Contributor Author

I've added in-file help text to make adding new files very easy. Simply open up the gh-pages branch and edit "pdf_bank.html" to find the help text.
It will be really clear what to do when you open the file. The edits can actually be done in the github file editor, you won't need a special compiler or anything like that.
Let me know if you do run into some confusion at any point and I'll answer any questions you have.

@missyschoenbaum
Copy link
Contributor

missyschoenbaum commented Jan 31, 2020

@ConradSelig I made an attempt, but it doesn't seem to be working. There are 2 parts of this:
First, I added pages to the NAADSM training and slightly changed the header wording.
Next I added one presentation to the new training - called overview.
The powerpoint files were too large to upload, so I had to convert to pdf.
Therefore we need to modify the wording slightly to point to only the pdf, and a second link to point to the Text Only version, which is saved as TrPages_TextSupport_Overview. So, we will still have 2 documents per topic, but one is pdf slides and other is pdf Text support.

Good thing I am not writing html for a living.

@missyschoenbaum
Copy link
Contributor

Update - NAADSM training part is working. Training part is not.

@ConradSelig
Copy link
Contributor Author

I'll take a look at this tomorrow morning. I'm sure we can get it working

@missyschoenbaum
Copy link
Contributor

@ConradSelig no rush, I didn't crater it

ConradSelig added a commit that referenced this issue Feb 1, 2020
Fixed a syntax error in naadsm_training.html and added ADSM Overview training block.
@ConradSelig
Copy link
Contributor Author

@missyschoenbaum That should fix it. Let me know if it doesn't look like what you want it to.

@missyschoenbaum
Copy link
Contributor

@ConradSelig Perfect! Should we move this ticket to testing?

@ConradSelig
Copy link
Contributor Author

I would say yes. Even if you have more training material to add it should be fairly cut and dry from here on out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants