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

chore: rename configuration language to modeling language #686

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rhamzeh
Copy link
Member

@rhamzeh rhamzeh commented Mar 7, 2024

Description

Replaces "Configuration Language" with "Modeling Language"

https://openfga.github.io/openfga.dev/pr-preview/pr-686/docs

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

@rhamzeh rhamzeh requested review from a team as code owners March 7, 2024 00:10
Copy link
Contributor

github-actions bot commented Mar 7, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://openfga.github.io/openfga.dev/pr-preview/pr-686/
on branch gh-pages at 2024-03-15 14:10 UTC

Copy link
Member

@matthewpereira matthewpereira left a comment

Choose a reason for hiding this comment

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

I have some casing and branding nitpicks.

link: './configuration-language',
id: './configuration-language',
title: 'Modeling Language',
description: 'Learning about the FGA modeling language',
Copy link
Member

@matthewpereira matthewpereira Mar 7, 2024

Choose a reason for hiding this comment

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

In docs/content/getting-started/immutable-models.mdx we use {ProductName}, here and in some other cases we use FGA - which do you prefer?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that Andres strongly prefers {ProductName} because it means the content can be recycled.

link: '../configuration-language',
id: '../configuration-language',
title: 'Modeling Language',
description: 'Learn about the {ProductName} Modeling Language.',
Copy link
Member

Choose a reason for hiding this comment

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

Elsewhere we seem to use sentence case, but here we use title case. I think sentence case is preferred, what do you think?

Copy link
Member

Choose a reason for hiding this comment

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

Ideally we would pick one strategy and make it consistent everywhere, but let me know if I'm missing some nuance here.

Copy link
Contributor

Choose a reason for hiding this comment

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

Section titles are going to be sentence case, yes. My plan is to slightly modify our current style guide for FGA purposes.

Copy link
Contributor

@pavokta pavokta left a comment

Choose a reason for hiding this comment

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

this is a lot of changes but it looks like they were handled honorably!

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.

3 participants