Comments (6)
Thanks @rabernat
I think I just pasted this on the wrong line. Apologies...
Admittedly I am flying a bit blind here. I think it might be good to show an example of 'what to replace' in the Remove the dummy content and add your content.
bullet?
I used some of the existing gallery repos to 'visually diff' the changes necessary, but clearly, I got confused in the process.
from xgcm-examples.
Agree it is currently super confusing. Would love suggestions on how to improve.
from xgcm-examples.
I just now saw this section.
Id suggest a few things:
- Link to that bottom section in the bullet mentioned above.
- Somehow mark and indicate which entries need to be changed. I personally like a concrete example (e.g. one of the existing gallery repos). Perhaps you could show the 'diff' output of the template and another repos yaml?
from xgcm-examples.
- This sentence ("Sometimes, the GitHub Action to add your repo as a submodule will fail. We can work with you to identify and fix issues. Sometimes, making a new issue in the same way as above is necessary to correctly reload new settings from your gallery repo.") is great advice, but I think it would be good to show the user what a 'success' looks like beforehand.
E.g. Before the sentence say: "If your request was successful, you will see an automated response like this:"
from xgcm-examples.
- I think the user then needs some more info about what will happen next and if they need to do anything except for wait for the gallery maintainers to merge?
from xgcm-examples.
@rabernat Should I paste these suggestions in another issue, so we can close this one?
from xgcm-examples.
Related Issues (10)
- Bot that updates the submodule in xgcm main repo?
- Environment (anaconda, pipenv, virtual env) needed for the notebooks? HOT 9
- Clarify the environments used for example development
- Mistake in computation horizontal divergence HOT 1
- MPIOM curvilinear grid examples
- Adjust thumbnail size
- environment: importing from xgcm bad on sciserver HOT 1
- Migrating notebooks HOT 4
- Example notebook to demonstrate `transform`
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 xgcm-examples.