suttacentral/bilara-data

2022 Static pages update project

Opened this issue · 0 comments

thesunshade commented

Guidelines from Bhante S

Overall, we should take a minimalist approach: change as little as we need to. I’d like to first concentrate on getting the whole UI up to date and ready to translate. Then we can maybe think about larger scale changes. FWIW, though, I want to focus on keeping SC itself as slim as possible, focussing on the texts and navigation.

One thing to bear in mind, given the nature of Bilara, it is simpler to make one-to-one changes than one-to-many. So if we can change the text while keeping the number of segments the same it will be simpler. Of course it is possible to change the segments, it just requires a bit more work.

Oh also one other thing, we should make sure we let the translators know when a file has been updated. Bilara doesn’t have an automatic way of doing this (but it should!)

One thing, in the updated About page, I tried to improve the Englishing as well. Avoid negative and double negative constructions, subsidiary clauses, and the like. Make everything simple, declarative sentences.

Obviously it depends on the context. If it’s the methodology page, probably only serious students will be interested. But for the general interest pages, make it as simple and clear as possible.

Another thought: try to make the wording as timeless as possible. That way it doesn’t get outdated. So i removed the reference to the current developers, as they come and go.

Oh, and an eleventh step: always put your edited JSON file in a JSON validator before pushing it. It’s super-easy to miss a comma or something. (I’ll add this to the method above.) I use:
https://duckduckgo.com/?t=ffab&q=json%2Bvalidator&atb=v236-1&ia=answer

How to do the changes

New work is constantly being added, so always

  • git checkout unpublished
  • git pull
  • do the work
  • validate the JSON
  • git commit -a -m "message here"
  • git pull
    • in case anything was pushed while you were working
  • git push

Once this is done, forward your changes to published as well.

  • Keep your text editor open
  • git checkout published
    • you’ll see the text change on the open page
  • git pull
  • ctrl + z
    • see the text revert to the latest changed version as per unpublished.
  • git commit -a -m "message here"
  • git pull
  • git push

And that should be all.

I just did this on the About page, just as a test, and it all seems to work fine.

  • the updated version is in the unpublished and published branches
  • the updated version has successfully forwarded to sc-data
  • it is also appearing in Bilara, so translators can make changes to their versions.

Resources