search

NAVADMC / ADSM

A simulation of disease spread in livestock populations. Includes detection and containment simulation.
Other
10 stars 5 forks source link

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

Open ConradSelig opened 5 years ago

ConradSelig commented 5 years ago

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 commented 5 years ago

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.

missyschoenbaum commented 5 years ago

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

ConradSelig commented 5 years ago

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 commented 5 years ago

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

ConradSelig commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

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

missyschoenbaum commented 5 years ago

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

ConradSelig commented 5 years ago

@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 commented 5 years ago

Did I put this in the wrong place? ghpages

ConradSelig commented 5 years ago

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

ConradSelig commented 5 years ago

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

missyschoenbaum commented 5 years ago

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

ConradSelig commented 5 years ago

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 commented 4 years ago

@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 commented 4 years ago

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

ConradSelig commented 4 years ago

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

missyschoenbaum commented 4 years ago

@ConradSelig no rush, I didn't crater it

ConradSelig commented 4 years ago

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

missyschoenbaum commented 4 years ago

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

ConradSelig commented 4 years ago

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