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

docs: make references to Seedcase software/products more uniform #28

Merged
merged 1 commit into from
Jun 6, 2024

Conversation

martonvago
Copy link
Contributor

@martonvago martonvago commented Jun 4, 2024

Description

This PR attempts to make references to Seedcase more uniform. I've tried to stick to the following guidelines:

  • "the Seedcase Project": always capital S and P; use to refer to the project as a whole (including underpinning ideas)
  • Bare use of "Seedcase": only allow when it refers to the project as a whole in very general terms
  • "Seedcase products" / "Seedcase software" / "Seedcase software products": use to refer to the software deliverables of the project; choose best fit based on context
  • "the Seedcase framework": use to refer to the collection of software deliverables that work together to implement the core functionalities; use in older documentation to shift the meaning away from a single product without rewriting large chunks of text that will probably change significantly anyway
  • "Data Resource": always capital D and R; use to refer to the data layer in the framework and its contents

I've also formatted the files I touched, so there are some whitespace and markdown changes. These are a bit more numerous than I was expecting, and they actually make these reviews super annoying to do -- sorry about that!

In general, these changes are pretty subjective and can be controversial, so feel free to be critical.

Related Issues: seedcase-project/design#21

Testing

  • Yes
  • No, not needed (give a reason below)
  • No, I need help writing them

Tested in the browser.

Reviewer Focus

This PR only needs a quick review.

Checklist

For general documentation:

  • Spell-check
    • US
    • UK
  • Did the page(s) preview correctly on your machine without breaking
  • New category words (keywords) (if any) added to the code snippet file

@martonvago martonvago self-assigned this Jun 4, 2024
Comment on lines +16 to +22
While the core of the Seedcase Project is the "Software" itself, it also
depends on the proper functioning of additional "blocks". Seedcase
Software relies on the two foundation layers, which are the
"Documentation" about the Software and its use as well as the "Culture
and Collaboration" that enables both Documentation and Software to be
developed. Supporting all these layers are the support structures that
tell "How" and "Why" things are done.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here and in the diagram, I put "Software" instead of "Product" to avoid implying that there is a single product. That said, I can see a sort of more abstract, collective reading of "Product" in this context that would cover all software deliverables, so happy to change it back.

Copy link
Contributor Author

@martonvago martonvago Jun 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I regenerated this and the code came out longer and different 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's odd. Might be an update with drawio. I feel this diagram needs to be updated anyway, but that's for another time.

@martonvago martonvago marked this pull request as ready for review June 4, 2024 12:23
@martonvago martonvago requested a review from a team as a code owner June 4, 2024 12:23
@lwjohnst86 lwjohnst86 merged commit be79fb8 into main Jun 6, 2024
1 check passed
@lwjohnst86 lwjohnst86 deleted the docs/seedcase-terminology branch June 6, 2024 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants