Site-www: Simplify the docs around what to ignore

[kevmoo]

Page: https://www.dartlang.org/guides/libraries/private-files

See the rational here: https://github.com/dart-lang/stagehand/commit/1f801774609cdc3013ba9f6ae8b43fab555c95f2

I'd also argue for removing the dartdoc item. Most folks don't generate docs locally – they rely on dartdot.org

We should optimize for the 95% case to keep this simple.

[kevmoo]

See also https://github.com/google/stagehand/issues/375

[Sfshaza]

I see that Kevmoo fixed this. Closing.

[kevmoo]

Nope. I fixed stagehand and GitHub's defaults.

We still need to update https://www.dartlang.org/guides/libraries/private-files

[kwalrath]

@kevmoo Do we really need to simplify private-files? I'd rather have it be complete than remove something and have someone not be able to find info they need. I think of it as a reference doc, more than a how-to doc, since stagehand and other standard files take care of the 95% case.

[kevmoo]

I think it's fine to leave the dartdoc bit – although I think it's pretty rare for folks to generate docs directly in their package - not sure.

I think we can remove Avoid committing generated JavaScript files: – all of our recommended flows have folks using our build system – which puts everything in the build directory. And that's already handled.

[kwalrath]

So it looks like all we need to do is remove this:

[Purukitto]

Hey @kwalrath , I would like to contribute to this.
Can you give a brief rundown on what's been done and what stills needs to be fixed?

[kwalrath]

Thanks for offering to help!

I think all we need to do is what's in my preceding comment (i.e., remove the paragraph and example about generated js files).

[Purukitto]

@kwalrath I removed the Avoid committing generated JavaScript files: section in the above referenced PR.

Also are the sections in the below sections still relevant after dart-lang/stagehand#549 and #1850 ??

[Purukitto]

Also are the sections in the below sections still relevant after dart-lang/stagehand#549 and #1850 ??

@kwalrath can you confirm this ? Otherwise I think it's safe to assume that this issue can be closed

[kwalrath]

Good catches! You're right that the "*.js" section can be deleted.

We should use a different example for the .gitignore paragraph. It probably shouldn't be IDE files, since those would be covered by the global gitignore.

Can you think of a good example of a project-specific file to be ignored?

[Purukitto]

@kwalrath

Good catches! You're right that the "*.js" section can be deleted.

Will do just that

We should use a different example for the .gitignore paragraph. It probably shouldn't be IDE files, since those would be covered by the global gitignore.

Can you think of a good example of a project-specific file to be ignored?

Some possible files can be something keys.txt or other library/dependency files that you might want the end user to download (node modules etc)

[kwalrath]

keys.txt makes sense to me.

[Purukitto]

keys.txt makes sense to me.

Alright then I'll remove the .js section and restructure the .gitignore paragraph

[Purukitto]

@kwalrath Should be fine to close this issue?-

[kwalrath]

Thanks, @Purukitto!