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

Merge terminology sections into one larger section #360

Merged
merged 2 commits into from
Aug 12, 2024
Merged

Conversation

MakisH
Copy link
Collaborator

@MakisH MakisH commented Aug 12, 2024

Touching this, a question would be whether we really want to have this and the Terminology as different sections at the same level. I would suggest:

  • Terminology
    • The term Research Software Engineering
    • Other terms

@CaptainSifff @jpthiele opinions?

@MakisH MakisH requested a review from CaptainSifff August 12, 2024 11:50
@MakisH MakisH self-assigned this Aug 12, 2024
@CaptainSifff
Copy link
Collaborator

Hi @MakisH , It's not that I don't see the point that you've raised, it's just that the current structure has proven/should prove useful:

  • We introduced the large chapter to have a discussion of the RSE at a clearly visible heading point with the intent of giving it it's own TOC entry.
  • The Terminology section has proven useful, to give a quick 1-2 Sentence summary of the terms that we have.

I mean currently subsubsection entries are rendered in the TOC. would it break your layout?

@CaptainSifff
Copy link
Collaborator

Do we have good alternative to "other terms"?

@jpthiele
Copy link
Collaborator

Further terms?

@CaptainSifff
Copy link
Collaborator

What about

  • Terminology
    • The concept of the Research Software Engineer (To have less term)
    • other definitions

@mhagdorn
Copy link
Collaborator

or further definitions

@mhagdorn
Copy link
Collaborator

We talked about this before. I understand why we want to have a separate section and was convinced that it is a good idea.

I think if we want to change something we should merge the two sections.

@MakisH
Copy link
Collaborator Author

MakisH commented Aug 12, 2024

I understand that it is useful to have this as a stand-alone entity, also in the table of contents. My only objection is that these seemingly related sections are at the same hierarchy level.

@CaptainSifff
Copy link
Collaborator

OK, then let's put it in a hierarchy as you suggested.

@MakisH
Copy link
Collaborator Author

MakisH commented Aug 12, 2024

Done:

Screenshot from 2024-08-12 17-19-36

@MakisH MakisH changed the title Use sentence case in all headings Merge terminology sections into one larger section Aug 12, 2024
@MakisH
Copy link
Collaborator Author

MakisH commented Aug 12, 2024

Which now generates the question of whether RSE is defined twice:

Screenshot from 2024-08-12 17-21-36

@CaptainSifff
Copy link
Collaborator

CaptainSifff commented Aug 12, 2024

Yes, but I would like to keep it that way. As the first two sentences are a directly citable instance of "Research Software Engineer".

@CaptainSifff CaptainSifff merged commit 4d1eb38 into main Aug 12, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants