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

Frontend proposal for C5 shutdown #2859

Merged
merged 1 commit into from
Nov 6, 2021

Conversation

brunoolivieri
Copy link
Collaborator

@brunoolivieri brunoolivieri commented Jun 18, 2020

This is an early and naive PR to discuss a very clean and plain new frontend to substitute C5 for ArduPilot main page. Here is a single page sample: www.olivieri.com.br/ardupilot/bootstrap/

The whole idea is to use plain HTML that could be updated inside the Wiki environment like any other Wiki's PR.

To proceed, I need to address some points:

  • The header and footer of the page are good enough? IFF it is close to being good enough, I can recreate the C5 pages statically. or try to create a new sphinx theme for those. (updated)

  • Presenting Discourse links and images alert users about cross-site items (SSL issue). I am not sure, but I guess this is not good for being found from google and other SEO stuff. Could we just present the text? XOR process it not dynamically on the client-side, but import it when the wiki is being built?

@brunoolivieri
Copy link
Collaborator Author

brunoolivieri commented Jul 2, 2020

This new commit updates the main page. It inserts ArduPilot wiki items: www.olivieri.com.br/ardupilot/bootstrap/

Any thoughts about header and footer? If not I will recreate the C5 other pages:

Partners
Wiki landing page
User cases
Team members

PS: BTW, Why not create another GitHub repo and use for a new frontend with these simple pages? I think that it would be more comfortable to maintain it outside the Sphinx environment and upgrade it later.

@Hwurzburg
Copy link
Contributor

How do I test this?

@brunoolivieri
Copy link
Collaborator Author

How do I test this?

@Hwurzburg
Not necessarily building. What do you think about the overall appearance and content?

@Hwurzburg
Copy link
Contributor

Hwurzburg commented Jul 2, 2020

How do I view it

@rmackay9
Copy link
Contributor

Looking forward to this!

@brunoolivieri
Copy link
Collaborator Author

Notes from weekly-devcall from 2020-07-20:

  1. Looks a good way to proceed.
    2)Logs section will stay by creating something in Python to run on the server-side.
  2. Separate repo or a page inside the Wiki repo?
  3. We’ll go ahead once we’ve got the blog posts happening.

@brunoolivieri
Copy link
Collaborator Author

brunoolivieri commented Sep 26, 2020

After some absence, I would like to return to this.

From weekly-devcall from 2020-07-20:

Item 1)
So, the last conversation was about to insert blog posts on that. So, I did a python script that creates a JSON in the server, and the pages load that.

There is a test version on http://wiki-beta.ardupilot.org:83/frontpage/

@rmackay9: Is that what do you were talking about for as the blog presentation on the main page? The number of posts can vary easily, and it is kind responsive to the screen.

Item 2)
I guess that is small enough to do not create a repo yet. I did a separate folder to make it easy to update and start an overlapping/overwriting "/ardupilot" folder.

@rmackay9
Copy link
Contributor

rmackay9 commented Sep 28, 2020

@brunoolivieri,

I was hoping that it would look a bit more like ardupilot.org does at the moment with the blogs appearing near the top and including the first picture and the top few lines of text. I think the blog posts should be one of the first things that people see when they come to ardupilot.org.

I also would like it if we could keep the news feed on the left although I don't know how many people actually use that so it's less of a priority.

@brunoolivieri
Copy link
Collaborator Author

brunoolivieri commented Sep 30, 2020

Get text from the Discourse is a little tricking because users' texts may have some self-made HTML.

I got the text and removed the standard HTML and shorted it for 140 characters for a couple of trials:

Layout 1 Basic blog images.
Layout 2 The community almost on the page top and title of the blog and lastest posts.
Layout 3 Layout 2 was added by the first 140 characters of the post itself.

@rmackay9 Is there something that you think is a good path to follow?

EDIT: note the error on the VTOL text in latest posts area...

@brunoolivieri
Copy link
Collaborator Author

ping @rmackay9

@brunoolivieri brunoolivieri self-assigned this Oct 19, 2020
@brunoolivieri brunoolivieri force-pushed the frontend2020 branch 2 times, most recently from c132ebf to fd69ef8 Compare January 19, 2021 00:29
@brunoolivieri brunoolivieri added this to Docs/Wiki in Roadmap 2021 Apr 11, 2021
@brunoolivieri
Copy link
Collaborator Author

We are restarting this initiative.

Please @Hwurzburg, check the 3 proposed laytouts and choose one. The main diferrence is how the page gets the last blog posts from the forum.

Then, I will do a script to build it during wiki building and we can test that.

@Hwurzburg
Copy link
Contributor

I like the third one.....not exactly the same but close enough....I think having it easily editable greatly outweighs any small issues with it not being the exact same format as the old....if we could measure it, I bet that jumps from this page are to documentation vastly outweighs any other

@brunoolivieri
Copy link
Collaborator Author

brunoolivieri commented Sep 22, 2021

So, to put it in place, I guess at least three things need to be put in place:

  • - insert it on the build script
  • - enhance the blog posts importer script (doing)*
  • - bug found when the first media is an youtube embed video
  • - bug on mixed content and youtube videos
  • - update plain pages and decide what to put on empty pages** (@Hwurzburg : Any advices?)
  • - clean the old stuff from commit...
  • - needs Add beautifulsoup4 package #3799 to pass on tests

*it works but some posts brings some trash

**so far, plain or empty pages are:

@tridge
Copy link
Contributor

tridge commented Sep 23, 2021

* enhance the blog posts importer script (doing)

I did some recent edits to the php script that imports blog posts. I could convert it to python if you like, or it could be used as-it.

Note that simplest initial solution is to create a HTML frame with this URL:

https://ardupilot.org/blogfeed-static.html

that URL is auto-updated from the php script and this is exactly how the C5 code works (HTML frame with that URL)

@brunoolivieri
Copy link
Collaborator Author

Thank you @tridge ! I wish I saw that php before. So, I did a python that get data from discourse JSONs.

@brunoolivieri
Copy link
Collaborator Author

brunoolivieri commented Oct 13, 2021

Well, I think we can go into a new round of feedback already.

Preview: http://wiki-beta.ardupilot.org:83/frontend/

There are at least two issues that can occur from the Discourse*:

  1. "Lastest posts on Community Blogs": Some image sizes can make the grid look bad. The second image is an example regarding the "html/css/js".

  2. "Lastest Community Forums posts": Some junk text from an HTML tag enters in some cases. I don't have an example at this point.

Merging this PR doesn't change kills C5 and doesn't redirect home to this site. Both can coexist for a while, and the configuration will be in Apache/Nginx.

*a python script gets some Json from discourse API and saves other Json consumed by the JS in the pages.

@brunoolivieri
Copy link
Collaborator Author

brunoolivieri commented Oct 19, 2021

Notes and feedback from the 2021-10-19 dev meeting:

  • - Make the Home link static
  • - Reorder "blog and forum posts" to come first
  • - Point discord link to the DEV page with the link
  • - "Stores" page needs to be moved to the .RST set of files
  • - Move "User Cases" to .RST files
  • - In fact, you should move as many files as possible to the .RST set of files
  • - Review all links
  • - Insert all pictures from C5 carousel
  • - PR from @khancyr to change youtube.com to youtube-nocookie.com for videos
  • - LOTS of enhancements from @khancyr \o/

@Hwurzburg
Copy link
Contributor

let me know if you need help on any of the .rst stuff

@brunoolivieri
Copy link
Collaborator Author

let me know if you need help on any of the .rst stuff

Thanks Henry. Could you help me with the User Cases? Maybe insert them in /Ardupiltot/ pages?

@Hwurzburg
Copy link
Contributor

link cases to this page which I have redone: common-use-cases-and-applications.rst

@khancyr
Copy link
Contributor

khancyr commented Oct 26, 2021

I have made another PR to finish the cleanup.
What I think we should still do :

  • Squash everything before merge to have clean git PR
  • Maybe remove Latest Community Forums posts ? I don't see the point on the main page as it is random posts ...
  • Fix uses case page
  • have a tool for formating ... here I use my IDE for formating
  • Check texts
  • fix some html and css. Too much BR balise and some static css that don't work on 4k screen
  • add a new team page

@khancyr
Copy link
Contributor

khancyr commented Oct 26, 2021

@Hwurzburg the related page isn't present on the wiki for now

@Hwurzburg
Copy link
Contributor

@Hwurzburg the related page isn't present on the wiki for now

Takes the place of use cases

@brunoolivieri brunoolivieri force-pushed the frontend2020 branch 4 times, most recently from 5112fe9 to 3a55269 Compare October 29, 2021 22:28
@brunoolivieri
Copy link
Collaborator Author

I think we finished the last set of proposals: http://wiki-beta.ardupilot.org:83/frontend/

@khancyr and @Hwurzburg : What you think about put it on next dev meeting?

@Hwurzburg
Copy link
Contributor

Looks great to me!

@brunoolivieri brunoolivieri removed the WIP label Nov 1, 2021
@brunoolivieri
Copy link
Collaborator Author

Merging as discussed and watching the building.

@brunoolivieri brunoolivieri merged commit 3edeb4f into ArduPilot:master Nov 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Roadmap 2021
Docs/Wiki
Development

Successfully merging this pull request may close these issues.

None yet

6 participants