-
Notifications
You must be signed in to change notification settings - Fork 26
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
Improve Continuously Deployed Web-page #1527
Comments
@Mornix which files should I be editing to update the webpage? |
I believe all of that is under |
Oh okay, I was looking in the gh-pages branch, but I guess everything there is automated through the |
Some useful makefile targets: I wouldn't recommend using |
Is this information also in, say, the |
"Year Summer" appearing before all example names is a bug in |
GitHub marked this as closed. It’s not. |
@smiths Did you have specifics in mind for the blurbs and descriptions for introduction, case studies, and contents? |
@danscime, no, I don't have anything specific in mind. We want to keep the blurbs short. The main thing is to explain what is actually be generated and linked to. You should make it clear that this is a CI deploy. Once you write something, assign it to me and @JacquesCarette for review. |
Some new ideas via bb9f5c0 |
@Mornix Also, the table (which we may choose to remove in favour of a list) is hardcoded in the sense that it is 2x4. Not sure how we want to go about this. |
Good start @danscime. Rather than a table of the case study artifacts, could you just list them individually under each case study? You could have your blurb describing the case study, and then links to the relevant documentation for that case study. That way all of the related information would be in the same place. The generated Haskell documentation seems to be missing? |
The documentation isn't show up at this link, so I did not add it to my version. I will remove the table. |
Next pass of the site: 8b6db65 |
@Mornix, how can I edit the files to add the description to each example? |
What is likely the best course of action is to add a directory along the lines of |
So I've made the descriptions into a separate folder and .txt files, but still not sure how to add the loading of descriptions into the site.hs file. |
Nice. Two modifications:
|
@danscime Since these (.txt) files don't get generated into complete web pages, we ignore some of the infrastructure setup by Hakyll and perform file IO and use the directory structure as a way to organize/associate data. The descriptions are actually the first non-generated piece of information being added to the site. The Lines 34 to 35 in ca7a883
For context, the links to generated source code are seeded from a file in the |
@danscime, can you please a dd a little more text to the introduction. Specifically, you can say what the case study artifacts are. Most visitors to our site will not immediately know what SRS stands for. You can have a sentence to say what the acronym is and what the purpose of the document is. We also want a description of what the package dependency graph means. We should also include a brief blurb about what Drasil is. That is, what does "generate all the things" mean. If you are having trouble with the text @oluowoj should be able to help. She has been giving this some thought in the context of the grant proposal that she is writing. |
@oluowoj If you could help, that would be great to have concise and meaningful sentences! |
This is what I have so far: This webpage is designed to contain the most up to date case study artifacts and package dependency graphs from the Drasil repository. The case study artifacts include the Software Requirements Specification (SRS) for the case study, which specifies what the program sets out to achieve, and how it will achieve those goals. The package dependency graphs shows the hierarchy of modules within each package. The footer of this page contains the continuous integration build of the project, as well as the commit number that the build and artifacts are based off of. |
This is a good start @danscime. My only suggestion at this time is that you take out the definition of the SRS that says "...and how it will achieve those goals." An SRS is about "what," it isn't supposed to address "how." 😄 |
I think I may make separate issues for some different changes we want to make in order to keep the issues cleaner and more organized. As of right now (91e656a), I have figured out how to add the descriptions to the examples. |
Unless I am missing anything, I think we can close this issue in favour of the newly created issues. |
I agree. We can close this issue. |
@Mornix has done a great job on the continuously deployed Drasil web-page (https://jacquescarette.github.io/Drasil/). Everything we want is automatically generated and update once a day. The next step is to make the web-page look better.
@danscime can you please make this web-page look better, especially with an external audience in mind. Some suggestions to improve the look of the page are:
To help with finding the page, we should also have a link to it from the main Drasil repo
Any other ideas you have to make the web-page nicer are most welcome. 😄
The text was updated successfully, but these errors were encountered: