Expanding the codex
Someone asked me yesterday about what different group roles (Admin, Mod, Member) meant, mentioning that the BP codex didn’t contain any information about this issue. So I decided to be a good citizen and create a starting guide for group setup: http://codex.buddypress.org/getting-started/group-settings-and-roles/
I’d like to encourage others to take the initiative of expanding the codex when the opportunity arises. That is, if you see a question being answered time and time again on the buddypress.org forums, or if you find yourself constantly referring others to a particular tutorial on how to accomplish something in particular within BuddyPress, consider taking a few minutes and adding it to http://codex.buddypress.org.
Moreover, if you notice that existing pages are incomplete or out of date, feel free to click the Edit This Page button at the lower left and make the fix. If not you, then who?
@johnjamesjacoby could I get admin on the codex blog so the team here has someone who can rearrange pages etc when needed?
I’m placing a codex wish here:
I honestly wish there was a thorough step by step guide about how to set up a lamp server from scratch with best practices to get BP running as smoothly as possible! I’m quite sure I’m not the only tec/server newbie on here trying to run BP with the best performance.
I know there are some performance hints on there, but that doesn’t really cut it in my opinion. Thanks to any bp server ninjas in advance!
Cool idea, @bpisimone. Does such a page exist on the WP codex? If not, maybe we could lobby to have one created there, and then create a BP codex page that adds additional information relevant to BP.
Quite a broad subject setting up a LAMP server from scratch! Doubt that WP or BP codexes will want to cover that in any great detail but definitely a detailed guide to running and maintaining a WP BP installation on Linux – permissions, folder structures, users/groups, backing up, scheduling tasks, caching in detail and perhaps a brief guide on how to not use FTP – an insecure and outdated protocol belonging to the dark ages, might be nice to try and cover setting up SFTP with perhaps VSFTPD to try and help move people on to a more secure implementation of FTP.
This is the only thing on the codex about theming and it just points to a plugin. https://codex.buddypress.org/how-to-guides/wordpress-to-buddypress-theme/
I think there should be a section on themes.
The default theme – a run down of how it works, how to install e.t.c.
Child theme – How to create, how to install e.t.c.
WP theme – How to convert, how to install e.t.c
Most people coming here will want the basics but I’d eventually dive into the developer area and add stuff about filters, functions and tags for designers.
There is actually another article:
But, I do agree that there should be a section for theme developers. The only thing I don’t want is too much duplication with the developer section.
I agree, but honestly it’s not about that, it’s presenting it in laymen’s terms. So maybe a developer section and a designer (theme) section?
@bpisimone – A good first step is to search the web and look for someone – anyone – who has put together a decent tutorial on at least part of the process you’re interested in. Hopefully they’ve released it under a CC or some other openish license. Then start compiling into something cohesive. No need to start from scratch or to reinvent the wheel.
@boonebgorges is Codex development for current BP 1.2+ only or also include upcoming BP 1.3 where there are changes not only in rendering BP components in Pages but also for creating themes as well?
Some quick suggestions re outline:
A. Installing and Activating BuddyPress
Make sure your WordPress 3.0 (single or multisite) is working. Check that the following functions are working before installing BuddyPress
– Pretty Permalinks
– Media upload and posting
– Registration process working – auto email send/receive working
– Can create sub-blogs (subdomain or subdirectory) for multisite installations
B. BuddyPress Basic Features and Settings (panels and subpanels)
e. @username Mentions
b. Edit Profile
c. Change Avatar
3. Blogs (if enabled)
b. Sent Messages
a. My Friends
a. My Groups
c. Delete Account
a. Internal bbPress
ii. Enabling for Groups
b. External bbPress
c. External Forums
i. Friends or Followers in codex? Followers in BP.org while Friends in testbp.org
ii. Private Messages – none on BP.org and testbp.org
C. BuddyPress Admin Bar
D. Customizing and Extending BuddyPress
#1-8 in B. above – per info already in the codex and will be added in Codex
– BP template tags (already there) – BP conditional tags
1. BP Theme Development
a, BP Child Theme
b. BP Template Pack
Note: the above may not be necessary in BP 1.3 per my initial tests
2. BP Plugin Development
Concur with @modemlooper that the codex needs more tutorial oriented material organised by use case: designer, developer, etc.
Also concur with @pollyplummer that template tag documentation (and other api, which I understand @jjj has planned for 1.3(4?)) is vital. @hnla – it would be good to have this structured by use case as well, as well as the PHPdoc alphabetical list of reference material.
I know there are some how ‘to use the loops’ articles… these could be expanded… related template tags, when to use, etc.
Well the part on making sure WP works could link to
@rogercoathup I agree; the lists are useful but there is a need for breaking down the anatomy of BP pages along with the relevant template tags if that makes sense, the lists should be under dev docs or similar, with theme structure explained with relevent info under Theming. My slight concern at the moment is that I think that themeing BP or at least the ‘Views’ aspect of the framework could do with, and will undergo some changes, not sure if or when that will happen though.
Modemlooper makes a good point that there will be much reference material that will be linkable to in the WP codex and that any entries made to the BP codex ought to check the WP codex for any useful pages in order that we aren’t duplicating effort.
I like your ideas for the theme sections of the codex. I know you’re good at the themes. I look forward to seeing the documentation you create on it.
@mercime – Thanks for the detailed outline. That’ll be a good starting point for some of those individual pages. As for theme structure: to the best of my knowledge, nothing major is changing in theme structure in BP 1.3 (unlike in 1.1 and 1.2). And since 1.4 is pretty far out on the horizon, there’s no reason to wait to get started. As for BP pages as WP pages – that part is still a little in flux (if I’m understanding the trunk correctly) but as of now those WP pages are still using the standard BP templates (so that eg the activity directory is coming from activity/index.php).
@boonebgorges – “As for BP pages as WP pages – that part is still a little in flux (if I’m understanding the trunk correctly)”
I’m sure you understand the trunk much more than I do Per my last test some weeks ago in dev install, the rendering of components as WP Pages made me think twice about sharing a theme that would be need to be revised in a few weeks. Will test trunk again this weekend
Going back to expanding BP Codex, set you PM from namoo.co.uk re BP Codex, hope you got it.
@boonebgorges – have we got any further forward on how we add new pages to the Codex, or on stubs / desired structure?
We worked with a little piece of code today (that’s also come up in other threads)…
Taking different actions in the activity loop based on the activity type, and then accessing appropriate data (such as post_id) within the activity
It would make a useful little how to page.
- The topic ‘Expanding the codex’ is closed to new replies.