Thanks Andreas! Documentation is still an ongoing process (and probably always will be :)), but we're happy things are in a better place these days.
In regards to your idea of moving the website repo (or the documentation within the repo) into the gem5 repo. I have four counter-arguments to this proposal: * Our standards for the website are lower than code. Things just get code reviewed quicker and with less scrutiny for the website. I don't think this is a bad thing, and wouldn't want to burden those wanting to submit quick changes to the website with that level of code review process. * We don't need CI (Kokoro) for website changes. So, it'd be a waste of steam running them for every change. * In the case we want to make updates to the website prior to a gem5 release, what do we do? How would this work with the website repo in develop branch? Do we always build the website from this branch? In which case, is the website going to be insync with what's going on in the develop branch or the latest stable release? We could allow website changes on top of the master branch, for things that need published ASAP, but I quite like the master branch being READ-ONLY between releases. * This would require either our website being split up between two repos or having the website and code repos merged. The former is a bit of an engineering pain. The latter infects the rest of the website with the problems stated above. As a good starting point, I think we should start tagging the gem5 website upon each release, just for the sake of good archiving. It may be good to also have a gem5 website develop branch, for documentation that needs to be merged into the master branch upon a release of gem5. Alternatively, we could also improve the website by adding different sections for different versions of gem5, but we're really reaching the limits of what we can do in Jekyll with regards to page hierarchies and tabs, so I'd worry about things getting a bit cluttered. We do things a bit neater for the Doxygen (FYI): http://doxygen.gem5.org/release/current http://doxygen.gem5.org/release/v19-0-0-0 http://doxygen.gem5.org/release/v20-0-0-3 Kind regards, Bobby -- Dr. Bobby R. Bruce Room 2235, Kemper Hall, UC Davis Davis, CA, 95616 web: https://www.bobbybruce.net On Wed, Aug 19, 2020 at 7:49 AM Andreas Sandberg via gem5-dev < gem5-dev@gem5.org> wrote: > Hi All, > > I just had a quick look at the excellent new documentation section on > the gem5 website. A big thanks to everyone who has worked on making that > a reality! > > One thing that I noticed when browsing the documentation is hosted in > the website repo and not the code repo. Would it make sense to move it > across to the code repo make sure it tracks the source code? > > In practice, we probably want to present (at least) two different views > of the documentation, one for the latest release and one for develop. > Another option would be to deal with versioning in the website repo, but > that will make it hard to keep the documentation up-to-date when > submitting code changes. > > Cheers, > Andreas > > IMPORTANT NOTICE: The contents of this email and any attachments are > confidential and may also be privileged. If you are not the intended > recipient, please notify the sender immediately and do not disclose the > contents to any other person, use it for any purpose, or store or copy the > information in any medium. Thank you. > _______________________________________________ > gem5-dev mailing list -- gem5-dev@gem5.org > To unsubscribe send an email to gem5-dev-le...@gem5.org > %(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s >
_______________________________________________ gem5-dev mailing list -- gem5-dev@gem5.org To unsubscribe send an email to gem5-dev-le...@gem5.org %(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
