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

Remove the (!) from Seeder Storage documentation, and explicitly document any meaning that was intended by it #13279

Closed
2 of 7 tasks
cincodenada opened this issue May 19, 2021 · 1 comment
Labels
stale type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference.

Comments

@cincodenada
Copy link
Contributor

Issue Description

What was unclear/insufficient/not covered in the documentation

The seeder documentation is very helpful, but has what I interpret as a "scare exclamation mark" in the documentation on changing the storage location of seeders. In the "Seed Storage" section:

By default the CLI will not save any seed that is executed. If you choose to change this behavior (!), you can use seederStorage in the configuration file to change the storage type

To me this implies that I should be cautious about changing this behavior, or that it is discouraged, but the rest of the docs have no explanation of why this might be, or what the pitfalls of changing this are. In contrast, the "Migrations Storage" section does have an explicit note about why "none" is not recommended.

If possible: Provide some suggestion on how we can enhance the docs

In any case, the exclamation mark should be removed, it serves only to sow uncertainty and confusion. If there are undocumented pitfalls, they should be noted explicitly (similar to the note about why "none" is not recommended for migrations) instead.

Additional context

This exclamation point has been around since this documentation was introduced in #8319, so I couldn't gain any insight about why it is there.

Issue Template Checklist

Is this issue dialect-specific?

  • No. This issue is relevant to Sequelize as a whole.
  • Yes. This issue only applies to the following dialect(s): XXX, YYY, ZZZ
  • I don't know.

Would you be willing to resolve this issue by submitting a Pull Request?

  • Yes, I have the time and I know how to start.
  • Yes, I have the time but I don't know how to start, I would need guidance.
  • No, I don't have the time, although I believe I could do it if I had the time...
  • No, I don't have the time and I wouldn't even know how to start.

(Ed: The PR is pretty incidental, what I'm missing is the knowledge of why the exclamation mark is there in the first place, and what it's trying to communicate)

@cincodenada cincodenada added the type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference. label May 19, 2021
@cincodenada cincodenada changed the title Either clarify what the (!) means in the Seeder documentation, or remove it Remove the (!) from Seeder Storage documentation, and explicitly document any meaning that was intended by it May 19, 2021
@github-actions
Copy link
Contributor

This issue has been automatically marked as stale because it has been open for 7 days without activity. It will be closed if no further activity occurs. If this is still an issue, just leave a comment or remove the "stale" label. 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference.
Projects
None yet
Development

No branches or pull requests

1 participant