lanefu

@miked @kriston @tido I want to make sure you all connect with each other. You've all contacted me about documentation content, file structure etc. I want to make sure you all aren't repeating work. Please provide some status on what you're working on. sorry i meant to post this here http://forum.armbian.com/index.php/topic/1540-400-implement-documentation-software-solution/

I just happened to come across a solution for this yesterday... it's a u-boot problem.. It can be fixed with an environment variable. see this post http://forum.armbian.com/index.php/topic/1180-orange-pi-lite-now-available/?p=12165

okay so the PSCI breadcrumb was a critical one.. thanks @jernej I think it IS a u-boot bug of some sorts... it led me to the bottom of this page I added another setenv line in /boot/boot.cmd setenv bootm_boot_mode=nonsec then did the mkimage command documented at the bottom of boot.cmd to remake script.bin and now I have 4 cores So the funny thing is H3 is supposed to default to HYP/non-sec mode.. and most of the u-boot configs for h3 look like they point that way, but i'm gonna have to look closer.. there's a few conditionals that look like it might flip the boot mode in the other direction. that's gratifying at east.. now if i could get rid of thermal read errors and make the onboard NIC work i'd be really excited. Thermal error just seems to be once on bootup. The CPU throttling actually seems pretty smart on mainline.. it'll take it down to 240 mhz. at idle.. I'm doing a stress test of yes > /dev/null & yes > /dev/null & yes > /dev/null & yes > /dev/null & and it stayed at 1296 mhz until it hits 75 C, then briefly throttles to 648mhz then back up.. pretty cool.

@miked It would be my preference that we leave the theme alone for now. We really just need something that works reliably from end to end. (Web, Mobile, PDF, Markdown Viewer) The current theme is sufficient. Re: Filenames, parent categories.. Ready, Fire, Aim! Nothing is locked in-now is the time to fix. Please follow the naming convention described here. Just to re-cap what I described yesterday, the end-game is for new content to be easily and rapidly deployed. Part of the reason for flat directory structure, and file-named based TOC is to let mkdocs and a few scripts do the work--often. I do have to circle back and add some sorting preset functionality to the generator script. Feel free to participate on this thread. Suggested Next Steps: Identify Parent Topics and preferred order Update / create documentation template(s) to assist in formatting (I made 1 example template. Adjust / replace as you see fit.) Draft a documentation standard and post Normalize formatting of exiting docs into new standard Validate that new formatting standard renders cleanly in PDF format Now that we're focusing on the actual documentation contents and formatting its probably time to move the conversation to the Documentation Task Topic.

I did some poking with my Opi One because I was having the same problem.. u-boot does have a default for 1008000 for the h3 devices.. most of the DTS files end up just including the Orange Pi PC DTS file I made a dinky u-boot patch and it works now, but there's other thermal stuff missing.. i get fun errors and only 1 cpu core in /proc/cpuinfo Naturally--I barely know what i'm doing diff --git a/configs/orangepi_one_defconfig b/configs/orangepi_one_defconfig index de6e9c8..4dd59a8 100644 --- a/configs/orangepi_one_defconfig +++ b/configs/orangepi_one_defconfig @@ -23,3 +23,7 @@ CONFIG_CMD_EXT4=y CONFIG_CMD_FAT=y CONFIG_CMD_FS_GENERIC=y CONFIG_USB_EHCI_HCD=y +##lj Clock freq defaults are 10080000 inherited from OPI PC default, kernel DTS doesn't have that speed, trying valid ones from kernel dts +CONFIG_SYS_CLK_FREQ=1200000000 +#CONFIG_SYS_CLK_FREQ=816000000 +#CLK_DIVIDER_ALLOW_ZERO=y ## didn't make my error go away

Okay I did a quick add to `process_contribute.md` I also pushed a simple documentation example template. I'm hoping that it'll be more compatible with PDF TOC stuff.. I'll try to test at some point.

mkArmbianDocs.py tentative enhancements: add sorting functionality add preset to sort prefered parent categories in a specified order sort unspecified parent categories at end, in alphabetical order sort sub-topics in alphabetical order

I have a few responses to some of the most recent concerns.... Too Many Documents--Creates TOC inconsistencies To encourage contribution from as much of the community as possible, several smaller documents is more appealing. It strongly minimizes the risk of merge conflicts, allows for more content creation in parallel, and allows the contributor to stay focused on specific content. TOC inconsistencies can easily be mitigated by provided a few empty markdown templates that provide scaffolding to keep the heading structure in place. The key to getting contribution is to minimize the barrier to entry as much as possible. AKA: quick, simple, easy for the contributor Here's the an example of an ideal workflow for adding documentation: Contributor clones repo Contributor copies ex: `templates/howto_template.md` to `docs/howto_new-topic.md` Contributor creates content within the simple framework provided by template Contributor commits and pushes to repo post-commit job runs a more intelligent version of `tools/mkArmbianDocs.py` and generates new mkdocs.yml post-commit builds new docs site, pushes, builds PDF (maybe--unless extra curation is desired) Contributor is delighted that creating a single markdown file was all that was needed to impact the community Contributor is inspired to create more content -- because it was soooooo easy. Permalinks--No Hope....ever On the short-term, permalinks will be unreliable. In the long-term I would expect most content structure to normalize and permalink reliability will fall with in acceptable terms. Also--search will fill in the gaps.

@Igor is your cron running mkdocs against the mkdocs.yml that is checked into the repo, or are you running the python script in tools to generate?

Try to keep discussion on the forums. Task Tracking Process Re: Content Order. yeah it needs to be optimized.. Right now the TOC is dynamically generated via a python script with no order other than grouping by topic. Need to figure out if its worth adjusting the tool, or just maintain mkdocs.yml manually.

maybe you can restate your question. what problem are you trying to solve? Tapatalk thinks its important to tell you im using tapatalk from a phone.

@Kriston Heads up...Sorry ended up changing the file naming convention 1 more time. I think that'll be the last.

Okay I've updated site, tool readme to use the Parent-Topic_Child-topic.md naming convention.

ya i guess that's all that's really needed. i was being lazy about retooling my regex. this will be simpler at least. ill get it updated Tapatalk thinks its important to tell you im using tapatalk from a phone.

Have you seen this? https://github.com/rosimildo/videoenc

great.. BTW there's a task topic already created for you. It'll inspire others if you can show status there http://forum.armbian.com/index.php/topic/1532-392-documentation-rework/

I've updated the repo, code, and readme to use _underscores_ instead of brackets. Haven't seen your cron update docs.armbian.com yet. perhaps i'm being impatient.

Glad to help. Connect with igor and get access to the new docs repo.. In the meantime you could clone and submit merge request https://github.com/igorpecovnik/lib.docs

the filenames with brackets are causing problems? any example on when its problematic / annoying? maybe just a single underscore _ between parent and child? Parent-topic_child-topic.md Good point. Brackets are considered unsafe. I'll switch to surrounding with underscores. _Parent-topic_child-topic.md Tapatalk thinks its important to tell you im using tapatalk from a phone.

Procedure Documented https://github.com/igorpecovnik/lib.docs/blob/master/docs/%5BProcess%5D-Armbian-Task-Tracking.md Current tasks created in Tasks subforum. Do we consider this complete enough to close? Should we create a second task for a git hook for forum creation?

@Igor Okay the new docs repo has been updated. I ported the docs to the new repo, added a working mkdocs.yml generator in the the tools folder, and provided some brief docs on how to use it / generate mkdocs. It's not quite sorting the way I want, but the Parent Categories are grouping correctly. This should be sufficient to let others contribute, polish etc.

okay cool.

i think its a good idea to move to a separate repo. are you suggesting markdown files in a repo w/o wiki or moving to a new repo and using new repo's wiki? Tapatalk thinks its important to tell you im using tapatalk from a phone.

* wiki updated to new naming convention * still working on mkdocs.yml generation script. filename parsing done. working on jinja iteration * todo: document the documentation process Tapatalk thinks its important to tell you im using tapatalk from a phone.

Since I've started moving forward with implementation, See this thread for implementation status and discussion. http://forum.armbian.com/index.php/topic/1540-400-implement-documentation-software-solution/