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 need better/more information related to static folder config #42

Open
ryanblock opened this issue May 16, 2020 · 6 comments
Open
Assignees
Labels
Docs Issue for Begin Docs (docs.begin.com) New doc Request a new doc

Comments

@ryanblock
Copy link
Member

ryanblock commented May 16, 2020

Which doc?
https://docs.begin.com/en/getting-started/static-assets

Describe the doc issue
Our docs do not explain anything about the @static folder, e.g.:

@static
folder foo

Describe how you'd like to see it improved
We should have concise but thorough documentation on how public/ + @static folder stuff works.

@ryanblock ryanblock added Docs Issue for Begin Docs (docs.begin.com) New doc Request a new doc labels May 16, 2020
@ryanblock
Copy link
Member Author

/cc @sw-yx

@swyxio
Copy link

swyxio commented May 16, 2020

might not be just a docs thing. the ui should also let me configure it (standard feature in peer platforms), as well as potentially teach me where to specify it in .arc. i'm a proponent of the idea that "the best docs are the ones you don't have to read"

@brianleroux
Copy link
Member

Unsure of we should enable/allow console modification to .arc ...kinda antithetical to Infra as Code. If we did it would probably just be an editor for the .arc file and commits changes to GitHub. Ryan wdyt?

@ryanblock
Copy link
Member Author

I was going to mention: we up until recently did enable this to be editable via the console! Then as we went deeper into our infra as code impl, we removed that UI.

I can go either way tbh but we heard that ppl were annoyed that they would do something in the console that would update git in the background, and then as they were working locally they’d suddenly have unexpected unmerged changes on master. ¯_(ツ)_/¯

Back to you: @sw-yx!

@swyxio
Copy link

swyxio commented May 17, 2020

ya i understand there is a tradeoff here and it compromises IaC. i dont think anyone else actually commits modifications to git either.

here's how vercel does it: explicit ui override
image

you can punt on this until you feel you have a strong opinion, baseline is still to improve docs, and then a possible second step is to think about whether we can use build log messages to teach the user what to do without looking at docs

@brianleroux
Copy link
Member

IaC determinism from source is really important concept but not well understood or common yet. I am glad to see they still don't get it yet. ;) So yes def priority a docs problem…also like using the build UI to teach. This is really helpful feedback so thx again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Issue for Begin Docs (docs.begin.com) New doc Request a new doc
Projects
None yet
Development

No branches or pull requests

5 participants