Comments (8)
Exploratory work
- Initial build partially successful in #209 with a basic
_config.yml
– does not contain any custom content from the originalconf.py
and there are currently a lot of warnings - How do we implement the top navigation bar pointing to the Infrastructure guide, Support and social links?
from docs.
- How do we implement the top navigation bar pointing to the Infrastructure guide, Support and social links?
Ah! I think this is achieved by using https://github.com/2i2c-org/sphinx-2i2c-theme
from docs.
Ah! I think this is achieved by using https://github.com/2i2c-org/sphinx-2i2c-theme
Correct :-)
If it's helpful, I'm happy to do a quick runthrough of the tech with you this week. Lemme know if that could save you some exploration time. Alternatively, if there is information you'd find useful that I could record in a write-up or a short video, let me know and I can do that asynchronously and share
from docs.
@choldgraf I made a fair amount of progress today and getting to grips with the tech! Thank you for the offer, I'll make sure to let you know if I come up against anything, but so far so good.
(I especially enjoy your breadcrumbs of knowledge spread throughout the internet, e.g. https://chrisholdgraf.com/blog/2022/sphinx-custom-crossrefs/) 😆
from docs.
hah glad you found that useful :-) I miss writing blog posts like that!
One word of advice: don't get too creative with Sphinx, because if we want to transition things to mystmd.org at some point, we don't want to have too much Sphinx-specific logic. I know that I've already built a bunch of sphinx-specific logic into the websites already and I regret it because it makes the sites harder to understand and maintain!
from docs.
I had a great chat with @agoose77, who provided a lot of clarity around some small questions that I had. The main outcome of the conversation is captured in #212.
from docs.
Exploratory work
- Regarding the main concern around getting the FreshDesk widget to work, I managed to do this in a
custom.js
file in commit 815b00f 🥳 - There are a few broken links to images hosted on GDrive related to their phase out of third party cookies. The recommendation is to use iFrames instead, but I have opted to upload the images to a folder in this repo in commit cdb94af
from docs.
Exploratory work
- I ran
jupyter-book build --builder linkchecker
and fixed all of the errors by either fixing the stale link "upstream" in our Google Drive https://github.com/2i2c-org/meta/issues/941 or amending out-of-date content. My next step is to upstream this to our 2i2c-org.github/workflows
and incorporate this into the CI/CD - I moved the custom scripts from
conf.py
into thescripts
folder and these will be run during CI/CD pre-build phase. I tried executing this code in Jupyter Notebooks at first within thejupyter build
command (à la the Jupyter Book docs), but the CSV file generated for the feature table was not detected by the rest of the build process, so thecsv-table
inabout/distributions/index.md
failed. - I have customised
.readthedocs.yml
to generate a preview usingjupyter-book build
rather thansphinx-build
👍
from docs.
Related Issues (20)
- Create a user off-boarding checklist for hub admins
- Document Grafana access for communities HOT 1
- [BUG] readthedocs actions doesn't provide a working URL to deploy preview when updating docs
- Upgrade Hub Service Guide to Jupyter Book HOT 3
- Document that the configurator is not available if using profileLists
- Write technical content for guiding communities on how to build custom images for their hubs. HOT 7
- Add how to edit users in admin/howto/manage-users/
- Directive to replace custom Python, e.g. list of running hubs and feature tables HOT 5
- [EPIC] Update workflows for the Hub Service Guide (docs.2i2c.org) to aid support work
- How-to guide for adding persistent storage buckets HOT 6
- How-to guide for tracking usage and costs in Grafana HOT 1
- Update how-to-guides/add-packages-to-image.md
- Document the usage of temp rather than $HOME for keeping temporary data files HOT 2
- Move https://github.com/yuvipanda/example-inherit-from-community-image to 2i2c-org and change into template HOT 2
- Create how-to on using dask-gateway for communities HOT 6
- Document use of cloud object storage HOT 4
- Document how to test JupyterHub images locally
- Create redirect from old customise image docs to new customise image docs HOT 3
- Tutorial for data transfer workflow for large datasets
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.