Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Embed Bylaws into a dedicated page #222

Open
1 of 10 tasks
theecrit opened this issue Oct 20, 2021 · 4 comments
Open
1 of 10 tasks

Embed Bylaws into a dedicated page #222

theecrit opened this issue Oct 20, 2021 · 4 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@theecrit
Copy link
Collaborator

What are you submitting?

Place an x in the appropriate bracket:

  • Bug (something's broken)
  • Feature request or improvement
  • Content update
  • Question
  • Other

Description

Currently, we link to our bylaws from various places on the website, including in the footer. This link pushes people off-site to a Google Doc. We'd like to embed this Google Doc in an internal web page. This will provide the following benefits:

  • Make navigation easier for visitors, so they don't have to bounce between Google Docs and the site.
  • Improve SEO by strengthening internal link paths.

Suggested approach

We already embed Google Forms on the site using Jekyll includes. See the src/_includes/embed-calendar.html and src/calendar/calendar.html files for an example.

Acceptance criteria

This issue will be considered addressed when the following criteria is met:

  • A page exists at openoakland.org/about/bylaws (openoakland.org/bylaws is fine, too)
  • That page contains a 1-2 sentence summary description of the Bylaws doc.
  • The page contains an embedded iframe containing the Bylaws Google Doc.
  • The iframe is tall enough to display at least a half-page of content at a time.
  • The iframe is responsive so it resizes with browser window width.

Thank you!

  • Please document your design and tech decisions in your pull request so others can follow along and understand why we've made the decisions we have.
  • If you'd like feedback, input, or help, share your thoughts or question in this issue's comments.
@theecrit theecrit added enhancement New feature or request good first issue Good for newcomers labels Oct 20, 2021
@theecrit theecrit added this to Backlog in Ongoing improvements backlog via automation Oct 20, 2021
@theecrit theecrit moved this from Backlog to Ready to work on in Ongoing improvements backlog Oct 20, 2021
@basiliskus
Copy link
Contributor

@theecrit Do you have a published URL to embed the doc? I think only the owner of the document can create the link (you can do that by going to: File > "Publish to the web")

@theecrit
Copy link
Collaborator Author

theecrit commented Nov 3, 2021

@basiliskus Here is the embed code, which you can tweak based on the live examples linked in the issue:

<iframe src="https://docs.google.com/document/d/e/2PACX-1vQPwPlg1Aq9gXXt6Ri1yN29MZxNgC627IXpK1hev2iyRUle7c8QsnUYW6MlUjUY71oDvi9814Z-i0Ym/pub?embedded=true"></iframe>

@basiliskus
Copy link
Contributor

@theecrit I have a couple of questions:

  • Do you have any suggestion for the summary description?
  • Should I update all link references including the brigade update posts? At the end of the Projects page, there is an anchor link: ombudspeople, which points to "VII. Code of Conduct Ombudspeople" section. That will be lost when linked to the embedded iframe. Would that be ok?

This is how it looks so far. The width size of the iframe is smaller than the google doc so the title is wrapping, but that'd be easy to fix by decreasing the title font size.

@theecrit
Copy link
Collaborator Author

theecrit commented Jan 15, 2022

@basiliskus I'm sorry this went so long without a reply, I somehow missed the tag!

Do you have any suggestion for the summary description?

We could adapt the language on the /how-we-work page to read: "OpenOakland's Bylaws outline the brigade structure, leadership roles, project requirements, decision-making processes, and additional brigade policies. OpenOakland's Steering Committee is expected to adhere to these Bylaws. However, they may be supplemented by non-binding policies and procedures documented elsewhere."

Should I update all link references including the brigade update posts?

That would be great, if it's not too burdensome.

At the end of the Projects page, there is an anchor link: ombudspeople, which points to "VII. Code of Conduct Ombudspeople" section. That will be lost when linked to the embedded iframe. Would that be ok?

Yep, that's fine.

The width size of the iframe is smaller than the google doc so the title is wrapping, but that'd be easy to fix by decreasing the title font size.

Yeah, that's fine, I can adjust the doc once this is live.

@theecrit theecrit moved this from Ready to work on to In progress in Ongoing improvements backlog Apr 3, 2022
@theecrit theecrit self-assigned this Apr 3, 2022
@theecrit theecrit mentioned this issue Apr 4, 2022
theecrit added a commit that referenced this issue Apr 7, 2022
@theecrit theecrit moved this from In progress to Done in Ongoing improvements backlog Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Development

No branches or pull requests

2 participants