Comments (3)
The shape of the solution
There are going to be a number of steps in getting this done. I think these steps are of sufficient size that we should split them out into separate issues to be worked on independently:
- Update the docs.ubuntu.com project, including:
- A library for reading the configuration file and pulling documentation sets into a build directory
- Symlinks from the templates & static directories to the latest version of the built documentation
- A manage.py script to kick off the build
- Update the spec to:
- Use Python 3 (documentation-builder needs python >= 3.5)
- Run the ./manage.py build job on a cron schedule
- Store the build directory in a shared location, e.g. using an nfs charm
- Mirror GitHub projects into Launchpad - we may have to pull from there instead
from docs.ubuntu.com.
I've now split this out into a number of issues, which should probably be done more-or-less in this order:
- #65: Methods for auto-updating an individual set of documentation from the source repository
- #64: Upgrade deployed environment to Python 3
- #66: Web-hook for triggering a new build of a documentation set
- Now we can do a release
- #63: Mirror documentation repositories into Launchpad
- #62: Implement shared filesystem in deployed environment (nice-to-have)
from docs.ubuntu.com.
After discussing this, we have decided it's not feasible. This is because it would require a persistent file-based storage layer in production, and we don't have a good solution for that right now.
The best hope for trying to address similar problems is now the kubernetes deployments plan.
from docs.ubuntu.com.
Related Issues (20)
- “Search Style Guide docs” does nothing useful HOT 2
- Juju link is broken
- Going to existing page without "/" in link fails HOT 2
- Action Required: Fix Renovate Configuration
- https://docs.ubuntu.com/phone/ still exists HOT 1
- Juju docs URL is outdated HOT 3
- Error on build docs HOT 1
- Documentation index is missing links for many products
- OpenStack uses the wrong letter case on the frontpage HOT 1
- Ubuntu Core docs search 404s HOT 2
- GTM - move docs.ubuntu.com from the ubuntu.com container
- Add new cookie policy
- Style guide docs: confusing to have first-level headings on the left and second-level headings on the right, with no semantic relation whatsoever HOT 2
- Update to Node 16 HOT 1
- Snap store proxy docs not current HOT 3
- Switch over to github actions
- Snap Store Proxy register link gives "Server error (500)" HOT 6
- Set up docs.ubuntu.com with sentry HOT 2
- Ensure docs.ubuntu.com logs get into graylog
- Sites not building HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.ubuntu.com.