Add Well-Understood paper to front page description #3705

daijingz · 2024-03-26T04:05:08Z

@samm82 Wait a moment for the new updates.
Inherited from previous PR #3686, but with some changes. Please wait for some further checks.

Closes #3360

Newest inspection: Coding style requirements.

Double spaces of indent levels.
Camel case variable names
Correct meaningful variable names.
Single blank lines between top-level objects.

JacquesCarette

The changes to the Website are far from pretty... but at (unfortunately) quite consistent with just how bad this code is. So those two changes are ok. Just the change to README needs improved.

JacquesCarette · 2024-03-26T16:37:01Z

README.md

@@ -21,7 +21,7 @@ Generate all the Things! Visit [our website](https://jacquescarette.github.io/Dr

 ## What is Drasil?

-For well understood domains, building software ought to be a matter of engineering, based on solid scientific foundations. The ultimate test of "well understood" is being able to teach the domain language to a computer. Drasil is a framework for generating all of the software artifacts for (well understood) research software, from the natural knowledge base of the domain.
+For well understood domains, building software ought to be a matter of engineering, based on solid scientific foundations. The ultimate test of "well understood" is being able to teach the domain language to a computer. Drasil is a framework for generating all of the software artifacts for (well understood) research software, from the natural knowledge base of the domain. The exhaustive summary of [well-understood](https://github.com/JacquesCarette/Drasil/blob/master/Papers/WellUnderstood/wu.pdf) domains and our original ideas include Drasil's primary information.


Rather than this, I would make "(well understood) research software" in the previous line be a link to the paper, and skip this whole new sentence.

samm82 · 2024-03-26T18:40:44Z

Also @daijingz, it's better to make any changes in a branch on your fork so that you don't need to "revert" your changes on your master branch, effectively removing your work from the PR (like in #3686).

daijingz · 2024-03-27T17:51:09Z

Also @daijingz, it's better to make any changes in a branch on your fork so that you don't need to "revert" your changes on your master branch, effectively removing your work from the PR (like in #3686).

There are two existing branches in my personal machine for other issues, and I will use your described tools.
@JacquesCarette sorry for concerns, I will improve in the future.

samm82 · 2024-04-01T21:19:03Z

code/drasil-website/lib/Drasil/Website/About.hs

+ namedRef icsePositionPaper (S "Old Position Paper") +:+ S "outlining our original ideas, a" +:+ 
+ namedRef danPoster (S "Drasil Poster") +:+ S ", and a" +:+ 
+ namedRef wellUnderstoodPaper (S "Well-Understood Paper") +:+ S "discussing key concepts."


This should use foldlList, or something similar. I seem to remember describing how to do this, as well as some other improvements, in a previous PR; you can use that as reference!

daijingz · 2024-04-09T05:27:44Z

Sorry everyone, there are some non-personal issues taking place on my PC, and I am going to go to repair stores tomorrow. I will get back tomorrow.

daijingz · 2024-04-17T18:00:34Z

@samm82 Newest update: have built two reusable wiki page sentences. This modification has some naming problems, and I am checking.

For the foldlList, I did not find some relevant code sections in the same program file. There is an example in this program file, however, it was used to represent an object list, where each hyperlink is separated by commas. However, this cannot work perfectly in the paragraph, as you can see, the input of foldlList has two input types: hyperlinks and sentences but this function can only have one type.

Can you show me the corresponding foldlList PR?

daijingz · 2024-04-17T18:07:18Z

Up to now my PR has a lot of commits, do not worry, later I will git rebase.

code/drasil-website/lib/Drasil/Website/About.hs

daijingz · 2024-06-03T04:59:54Z

Let me think about more possible improvements. (Updating)

samm82 · 2024-06-03T14:37:03Z

I would hold off on making any more changes in this PR (unless you learn how to use Git properly; it's hard to see what changes you've made since my last review, and just putting the issue number as the commit message doesn't provide any additional information about what change(s) was/were actually made!)

daijingz · 2024-06-03T16:24:40Z

I would hold off on making any more changes in this PR (unless you learn how to use Git properly; it's hard to see what changes you've made since my last review, and just putting the issue number as the commit message doesn't provide any additional information about what change(s) was/were actually made!)

I am going to keep my updated version here (without any further changes). Before I just had continuous inspections on grammar, indentations, and content. I did not find a place worthy to change -> I feel, for some parts, it is better not to change instead of change. Up to now I did not find any violations with the Contributor's Guide.

daijingz · 2024-06-03T16:26:28Z

I am going to publish my new draft branch for another issue tomorrow. (Just to indicate my previous changes, all of you do not need to give any suggestions) (There is something I hesitate to determine.)

balacij · 2024-06-05T05:11:57Z

To add to @samm82's comments about git, @daijingz, it would be nice if you could squash all of your commits into one or two commits. Also, you don't need to sync your branch as frequently as you do with master -- it's really only needed when there's a merge conflict showing up in the PR. Regarding your git commit messages, your objective with commits is to write a code change, ultimately. However, to make it understandable, you want to give readers of the code change (the commit) a quick summary (the commit message) before they read your code, so that they know what they're looking at and what to critique.

For example, in this PR, you are:

Fixing a few typos in the existing website content
Adding a link to the Well-Understood paper to the README.md
Adding a few highlighted document links to the website content (namely, the original position paper, a poster, and the well-understood paper)

Now, these are 3 separate things you've done in this PR (which I think are all fair for one PR, and are all good, so thank you :) ). These 3 separate tasks can all fit into their own commits. However, I would make the commit messages just a tad more terse:

Website: Fix a few typos
README.md: Add a link to the Well-Understood paper
Website: Highlight a few documents (original position paper, a poster, and the well-understood paper)

Of course, it would be expected that the commit messages sufficiently line up with what code was actually changed.

Actually, you can just make compress this down to just 2 commits:

README.md: Add a link to the Well-Understood paper
Website: Fix a few typos and highlight a few documents (original position paper, a poster, and the well-understood paper)

With these prospective commit messages, I think you can squash the existing commits (difficult) and/or soft reset the entire branch and recommit the changes gradually (simpler).

NOTE 1: You do not need to close this PR and start anew if you want to fix your commits. You will just need to use a force-push on your remote branch to fix the commit history.

NOTE 2: I don't think you should add any more changes to this PR. It looks fine as it is, in my opinion. The git commit history could probably be cleaned up a bit, however.

Aside: I probably have some auto commits around, but I fully intend to fix my own commit messages as well going forward.

daijingz · 2024-06-05T16:21:18Z

Sure, let me think about changing it (Really messy in the commit message right now)

Meet some problems right now, because the squash option is disabled.
Maybe the failure is because of my branch Drasil_Copy_1 usages, so that all previous commits are temporarily disabled.

Up to now I am unable to get back to my master branch, and here is the error message:

I guess the most possible case is because Dr.Carette had not merged this PR from the master's branch, but merged another now from the copy branch. @samm82 Can you give me some help to fix this?

balacij · 2024-06-06T19:14:30Z

What is that error message from?

smiths · 2024-06-06T19:26:48Z

@balacij you provide some great advice above. Can you or one of the summer students add this advice to our Contributor's Guide? I like your advice about squashing commits and only merging with master when necessary. Your advice on commit messages is also valuable. We might already have some of this in the Contributor's guide.

daijingz · 2024-06-09T04:25:42Z

What is that error message from?

@balacij From Git Desktop, when I switched my current branch to master, it had this error message.

I tried to use commands today but it did not work. Also, when I selected multiple commits, by right-clicking, the option squash ... commits was in grey, meaning it was unavailable. I guess there are some problems, but I have not found an efficient way to solve this, and others feel unfamiliar with this error. Please help me.

@JacquesCarette There is a new PR completed today, should I submit before fixing this error?
Here is the screenshot:

balacij · 2024-06-11T14:49:53Z

@daijingz Can you please try out the branch in #3793 ? I think that should fix your issue.

daijingz · 2024-06-11T16:04:55Z

@daijingz Can you please try out the branch in #3793 ? I think that should fix your issue.

Sure

…-and-Chunks;-Meeting-June-7th,-2023.md

…-and-Chunks,-Meeting-June-7th,-2023.md

This reverts commit ce456e6.

daijingz · 2024-06-15T03:22:26Z

Fixed. Now I can squash commits, and please wait a moment.
There is a problem: on the GitHub desktop, I tried to drag my commits to the target squash commit. It shows a lot of options after choosing to squash. However, after determined to squash, I did not see any response from the commit message terminal. That is, the original two commits did not combine, and they stayed separate as before.
@samm82 @balacij do you have office hour so that I can get assistance? But just wait for a few minutes, because I am still trying other ways.

After this page, it shows that squash success, but I did not find any change on the same page (it seems like there is nothing change):

daijingz added 16 commits January 22, 2024 17:16

JacquesCarette#3360

03748eb

Merge branch 'master' of https://github.com/daijingz/Drasil

9af6495

Merge branch 'JacquesCarette:master' into master

a876566

Update README.md

d386d30

Merge branch 'JacquesCarette:master' into master

a76d086

JacquesCarette#3686

f9441cf

JacquesCarette#3686

e9152a9

JacquesCarette#3686

493a655

JacquesCarette#3686

7ad852e

Merge branch 'JacquesCarette:master' into master

fa57c6c

Merge branch 'JacquesCarette:master' into master

eb2d515

Update About.hs

7faccf6

JacquesCarette#3686

2446d85

JacquesCarette#3360

362da84

Merge branch 'master' of https://github.com/daijingz/Drasil

1d5470b

Merge branch 'JacquesCarette:master' into master

dbd8c79

daijingz requested a review from JacquesCarette as a code owner March 26, 2024 04:05

JacquesCarette requested changes Mar 26, 2024

View reviewed changes

Update README.md

54a6b57

daijingz requested a review from JacquesCarette March 27, 2024 17:51

samm82 requested changes Apr 1, 2024

View reviewed changes

daijingz added 3 commits April 12, 2024 21:34

Merge branch 'JacquesCarette:master' into master

165e752

Update About.hs

c078bae

Update index.html

68dd414

samm82 requested changes Apr 17, 2024

View reviewed changes

code/drasil-website/lib/Drasil/Website/About.hs Outdated Show resolved Hide resolved

code/drasil-website/lib/Drasil/Website/About.hs Outdated Show resolved Hide resolved

daijingz added 3 commits May 17, 2024 01:51

Merge branch 'JacquesCarette:master' into master

8329b26

Merge branch 'JacquesCarette:master' into master

612f74f

JacquesCarette#3360

0166340

daijingz requested a review from samm82 June 3, 2024 04:40

Merge branch 'JacquesCarette:master' into master

f17b16e

balacij mentioned this pull request Jun 7, 2024

Contrib. Guide: Add recent advice related to git commits #3784

Open

Merge branch 'JacquesCarette:master' into master

3182b8e

daijingz mentioned this pull request Jun 10, 2024

Non-Issue Contributes to Minor Drasil Website Inconsistencies #3790

Open

balacij mentioned this pull request Jun 11, 2024

Wiki Workflow: Ensure all files have windows-friendly names #3793

Merged

balacij changed the title ~~Contributes to issue: Should add Well-Understood paper to front page description #3360 (Attempt)~~ Add Well-Understood paper to front page description Jun 11, 2024

daijingz added 2 commits June 14, 2024 20:33

Merge branch 'JacquesCarette:master' into master

01be884

Update Wiki.yaml

c6971a3

daijingz requested a review from balacij as a code owner June 15, 2024 00:52

daijingz added 5 commits June 14, 2024 20:58

Rename Attributes-and-Chunks:-Meeting-June-7th,-2023.md to Attributes…

78b8aa7

…-and-Chunks;-Meeting-June-7th,-2023.md

Rename Attributes-and-Chunks;-Meeting-June-7th,-2023.md to Attributes…

20b2f56

…-and-Chunks,-Meeting-June-7th,-2023.md

Update _Sidebar.md

767c18e

Fix Grammar Typos

ce456e6

Revert "Fix Grammar Typos"

ae77541

This reverts commit ce456e6.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Well-Understood paper to front page description #3705

Add Well-Understood paper to front page description #3705

daijingz commented Mar 26, 2024 •

edited by balacij

JacquesCarette left a comment

JacquesCarette Mar 26, 2024

samm82 commented Mar 26, 2024

daijingz commented Mar 27, 2024 •

edited

samm82 Apr 1, 2024

daijingz commented Apr 9, 2024

daijingz commented Apr 17, 2024 •

edited

daijingz commented Apr 17, 2024

daijingz commented Jun 3, 2024 •

edited

samm82 commented Jun 3, 2024

daijingz commented Jun 3, 2024 •

edited

daijingz commented Jun 3, 2024 •

edited

balacij commented Jun 5, 2024 •

edited

daijingz commented Jun 5, 2024 •

edited

balacij commented Jun 6, 2024

smiths commented Jun 6, 2024

daijingz commented Jun 9, 2024 •

edited

balacij commented Jun 11, 2024

daijingz commented Jun 11, 2024

daijingz commented Jun 15, 2024 •

edited

Add Well-Understood paper to front page description #3705

Are you sure you want to change the base?

Add Well-Understood paper to front page description #3705

Conversation

daijingz commented Mar 26, 2024 • edited by balacij

JacquesCarette left a comment

Choose a reason for hiding this comment

JacquesCarette Mar 26, 2024

Choose a reason for hiding this comment

samm82 commented Mar 26, 2024

daijingz commented Mar 27, 2024 • edited

samm82 Apr 1, 2024

Choose a reason for hiding this comment

daijingz commented Apr 9, 2024

daijingz commented Apr 17, 2024 • edited

daijingz commented Apr 17, 2024

daijingz commented Jun 3, 2024 • edited

samm82 commented Jun 3, 2024

daijingz commented Jun 3, 2024 • edited

daijingz commented Jun 3, 2024 • edited

balacij commented Jun 5, 2024 • edited

daijingz commented Jun 5, 2024 • edited

balacij commented Jun 6, 2024

smiths commented Jun 6, 2024

daijingz commented Jun 9, 2024 • edited

balacij commented Jun 11, 2024

daijingz commented Jun 11, 2024

daijingz commented Jun 15, 2024 • edited

daijingz commented Mar 26, 2024 •

edited by balacij

daijingz commented Mar 27, 2024 •

edited

daijingz commented Apr 17, 2024 •

edited

daijingz commented Jun 3, 2024 •

edited

daijingz commented Jun 3, 2024 •

edited

daijingz commented Jun 3, 2024 •

edited

balacij commented Jun 5, 2024 •

edited

daijingz commented Jun 5, 2024 •

edited

daijingz commented Jun 9, 2024 •

edited

daijingz commented Jun 15, 2024 •

edited