Comments (29)
I definitely think it is a good idea to add enough context like MDN.
What do you think @OurTechCommunity/core?
from catchup.
Yeah I think adding a section like MDN at the bottom is a nice idea!
@sushma1031 can you design something like MDN that you like? We can go ahead from there. Do post a screenshot!
from catchup.
Sure.
Here is a layout you could follow:
Improve the content on this page?
[Edit the summary on GitHub](https://github.com/OurTechCommunity/catchup/blob/main/summary/sessions/130/content.adoc).
[Report the content issue](https://github.com/OurTechCommunity/catchup/issues/new?title=Improve%20%3Cnum%3E%20summary&body=Enter%20summary%20URL%20and%20changes%20to%20be%20made:).
[View the source on GitHub](https://github.com/OurTechCommunity/catchup/blob/main/summary/sessions/130/content.adoc).
Want to get more involved? [Learn how to contribute](https://github.com/OurTechCommunity/catchup/blob/main/CONTRIBUTING.md).
Renders like:
Improve the content on this page?
Edit the summary on GitHub.
Report the content issue.
View the source on GitHub.
Want to get more involved? Learn how to contribute.
from catchup.
Do modify the links to include the correct CatchUp numbers, @sushma1031 !
Thank you for the example, Tushar!
from catchup.
One second, just realized this is an issue.
@sushma1031, please feel free to open a PR.
The UI looks great :D
from catchup.
I think we need to debate on the position of this section. It looks good at the bottom, but I think it should be above the quotes and below the note with the blue icon.
Yes, let's place the content above the horizontal rule above the quotes. Would look good hopefully!
We might get rid of that note, but that's another issue - we really need to restructure our summary page.
Right. Let's figure that out at #113
from catchup.
Following the same layout for the combined summary page:
Code:
[.improve-heading]
Want to improve the content of this page?
[.improve-buttons]
* link:https://github.com/OurTechCommunity/catchup/tree/main/summary/sessions[Edit these summaries on GitHub.^]
* link:https://github.com/OurTechCommunity/catchup/issues/new?title=Improve%20combined%20summary&body=Enter%20changes%20to%20be%20made[Report the content issue.^]
* link:https://github.com/OurTechCommunity/catchup/blob/main/summary/combined-summary-template.adoc[View the source on GitHub.^]
[.contribute]
Want to get more involved? link:https://github.com/OurTechCommunity/catchup/blob/main/CONTRIBUTING.md[Learn how to contribute.^]
from catchup.
I'd like to work on this.
I'd like to request some clarification:
- Are there any specifications about the appearance of the button?
1.1. In the Next.js example, it's just displayed as a link, is the same required here as well? - Should the button direct them to the GitHub repo, or something more specific?
from catchup.
I'd like to work on this.
Awesome! Thank you!
I'd like to request some clarification:
- Are there any specifications about the appearance of the button?
1.1. In the Next.js example, it's just displayed as a link, is the same required here as well?
A link at the top of the page would be just fine!
- Should the button direct them to the GitHub repo, or something more specific?
- For Individual summaries
- The link should redirect to the summary directory pertaining to every CatchUp session (
summary/sessions/<catchup_number>
). - Example: The link on the 130th OTC CatchUp session summary page should redirect to
https://github.com/OurTechCommunity/catchup/tree/main/summary/sessions/130
. - Individual summary template: https://github.com/OurTechCommunity/catchup/blob/main/summary/individual-summary.adoc
- Hosted individual 130th summary: https://catchup.ourtech.community/summary/130
- The link should redirect to the summary directory pertaining to every CatchUp session (
- For the combined summary
- The link should redirect to
https://github.com/OurTechCommunity/catchup/tree/main/summary/sessions
. - Combined summary template: https://github.com/OurTechCommunity/catchup/blob/main/summary/combined-summary-template.adoc
- Hosted combined summary: https://catchup.ourtech.community/summary
- The link should redirect to
Do let us know if you have any more questions! Also, do add pictures of how the pages look like, whenever you contribute!
Thank you!
from catchup.
I think you're trying to add the link at the wrong place.
Try adding link:https://github.com/OurTechCommunity/catchup/tree/main/summary/sessions/130[Edit this summary on GitHub^]
above line no. 17 of the individual-summary.adoc
file:
catchup/summary/individual-summary.adoc
Line 17 in 7253154
from catchup.
I gave that a try, this is the result:
If this is the required result, please let me know, I'll do the same for the combined summary as well
from catchup.
@sushma1031 can you please try reducing the font size and send a screenshot of that?
Feel free to send pictures with any other looks that you think work better as well.
Cc: @tusharnankani
from catchup.
Will do!
from catchup.
I personally found the extra space at the top unappealing:
Hence I tried to make it even using css relative position
Let me know your thoughts
from catchup.
Hey
Looks good, yeah.
Should we reduce the font size of the 'edit' link, @tusharnankani?
Yes.
Also, what do you think if we push the button to the bottom?
Something like this at MDN: https://developer.mozilla.org/en-US/docs/Web/javascript
from catchup.
Let us know if you need any help!
from catchup.
I'll work on it.
I'd like to request some more information, such as what we want to include in this section, in addition to the edit summary link.
from catchup.
I'll make sure to include the respective numbers @HarshKapadia2.
Thank you for the layout @tusharnankani !
from catchup.
Here's my code:
[.improve-heading]
Want to improve the content of this page?
[.improve-buttons]
* link:https://github.com/OurTechCommunity/catchup/tree/main/summary/sessions/{catchup_display_number}[Edit this summary on GitHub.^]
* link:https://github.com/OurTechCommunity/catchup/issues/new?title=Improve%20%3C{catchup_display_number}%3E%20summary&body=Enter%20summary%20URL%20and%20changes%20to%20be%20made[Report the content issue.^]
* link:https://github.com/OurTechCommunity/catchup/blob/main/summary/sessions/{catchup_display_number}/content.adoc[View the source on GitHub.^]
[.contribute]
Want to get more involved? link:https://github.com/OurTechCommunity/catchup/blob/main/CONTRIBUTING.md[Learn how to contribute.^]
Let me know if any changes are required.
Also, my CSS changes are being ignored by Git, as the summary-style.css is present in the .gitignore file. Could you please let me know what I should do?
from catchup.
I like how this looks! What do y'all think @OurTechCommunity/core?
I think we need to debate on the position of this section. It looks good at the bottom, but I think it should be above the quotes and below the note with the blue icon. (Picture below.) (We might get rid of that note, but that's another issue - we really need to restructure our summary page.)
Also, my CSS changes are being ignored by Git, as the summary-style.css is present in the .gitignore file. Could you please let me know what I should do?
Summary styles are located in https://github.com/OurTechCommunity/catchup/blob/main/summary/static/css/summary-style.css, so please make your changes in that file. (I think the file that you're referring to is the file that is copied over to public/css/summary
while building the site.)
from catchup.
Summary styles are located in https://github.com/OurTechCommunity/catchup/blob/main/summary/static/css/summary-style.css, so please make your changes in that file. (I think the file that you're referring to is the file that is copied over to
public/css/summary
while building the site.)
I was trying to update the wrong file as you pointed out. Thanks for directing me to the right one!
from catchup.
This is how it looks:
I was wondering if I should change the colour of "Want to improve the content..." to match these sub-headings:
from catchup.
I was wondering if I should change the colour of "Want to improve the content..." to match these sub-headings:
No, let's keep the normal black text for now.
from catchup.
Good idea, @dheerajdlalwani!
Some options for the button text:
- Suggest changes
- Edit summary on GitHub
from catchup.
I'm having trouble adding a link at the top of the page. This is my code for a test link:
= OTC CatchUp #{catchup_display_number} Summary
Our Tech Community
v1
:revremark: link:https://catchup.ourtech.community[Test Link^]
Could you please suggest the appropriate syntax?
Alternatively, I could add the link at the bottom:
from catchup.
Should we reduce the font size of the 'edit' link, @tusharnankani?
from catchup.
Reducing the font size to 1rem appears like this:
Code:
[.edit-summary-btn]
link:https://github.com/OurTechCommunity/catchup/tree/main/summary/sessions/{catchup_display_number}[Edit this summary on GitHub^]
CSS
.edit-summary-btn a{
font-size: 1rem;
}
from catchup.
Applying 0.75 rem made it look too small according to me, however let me know your opinion:
from catchup.
Sure @tusharnankani , I can try that. It would look similar to this, although here I haven't reduced the font size yet:
Also, should I add a message above the link, like in the MDN docs, or is just the link sufficient?
cc: @HarshKapadia2
from catchup.
Related Issues (20)
- feat: Switch to `:toc: left` for the combined summary page HOT 2
- bugfix: Update actions dependent on deprecated versions of node HOT 1
- cleanup: Remove `alt-start` script from package.json HOT 6
- cleanup: Migrate all markdown files to asciidoc HOT 2
- Update UI for summary page HOT 7
- Hamburger menu consistency across all pages. HOT 1
- Redirect to OTC Talks Web Site. HOT 3
- Add Prettier linting instructions to `CONTRIBUTING.md`. HOT 3
- Add PR checklist. HOT 3
- Add an optional Prettier pre-commit hook. HOT 2
- Error in superscript ordinals HOT 4
- Video element overflows on summary pages when screen width is less than 700 px. HOT 6
- Automate linking Twitter handles in `attendees.adoc` HOT 17
- Improve Documentation for Attendee List Generation Scripts.
- New Telegram/Twitter Actions workflow error. HOT 4
- Refactor Twitter & Telegram Action name & description. HOT 1
- Links in Attendee Map Overridden by `null`. HOT 1
- Add a `devcontainer.json` for all Dependency Needs. HOT 1
- Migrate catchup site to Cloudflare serverless functions 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 catchup.